Creditsafe Connect API Documentation

Return Business AML Search Hits

Returns the business AML search hits from the AML search results.

SecuritybearerToken

Request

path Parameters

searchId

required

string

query Parameters

page	integer Default: 1 Starting page number.
pageSize	integer <int32> Default: 10 Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.
hitDecisions	string The hit decisions. Available Values - [undecided, truematch, falsepositive, discarded]

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/compliance/kyc-protect/searches/businesses/{searchId}/hits

Request samples

Response samples

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hitScore": 0,
"name": "string",
"match": "string",
"countries": ["string"
],
"datasets": ["string"
],
"decision": "string",
"note": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"supersededHit": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"hitScore": 0,
"name": "string",
"match": "string",
"countries": ["string"
],
"datasets": ["string"
],
"decision": "string",
"note": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
}
],
"totalSize": 0
}

➔ Next to Update Batch Of Business AML Search Hits