Creditsafe Connect API Documentation

Returns Individual AML Search Hits

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

SecuritybearerToken

Request

path Parameters

searchId

required

string <uuid>

The search identifier.

query Parameters

hitDecisions	string The hit decisions. It can be the collection of undecided, trueMatch, falsePositive, discarded
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.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

get/compliance/kyc-protect/searches/individuals/{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",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"datesOfBirth": ["2019-08-24"
],
"pepTier": "string",
"profileImages": "string",
"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",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"datesOfBirth": ["2019-08-24"
],
"pepTier": "string",
"profileImages": ["string"
]
}
}
],
"totalSize": 0
}

➔ Next to Updates A Batch Of individual AML search Hits