International screening - interpret results of a check | API

Created by Tomas Gibbons, Modified on Fri, 16 Aug, 2024 at 12:38 PM by Hannah Rowe

Example result response body

This section will focus on the response body returned from our GET /api/v2/ci/entities/{entityId}/data-checks/sanctions-and-peps if a new check has been performed.

If you would like to review the results of a previously completed check you can perform a GET against /api/v2/ci/entities/{entityId}/data-checks/{dataCheckId}/sanctions-and-peps provided you have the datacheckId & entityId stored.

Response body - no match

{

"results": [],

"id": 4919,

"dateCreated": "2023-09-05T10:25:55.317",

"status": 2,

"request": {

"threshold": 85,

"firstName": "Tomas",

"middleNames": "",

"lastName": "Gibbons",

"dateOfBirth": "2023-09-05T00:00:00",

"dateOfBirthMatching": 0,

"datasets": [

"countries": [],

"nameMatching": 0,

"useAllCountries": true,

"useAllPepTiers": true,

"pepTiers": []

"resultsCount": 0,

"isOnGoingMonitor": false,

"isOnGoingMonitorActive": false

}

dataCheckId

It is important that you store the dataCheckId that is returned as part of this response body. This ID is used in conjunction with the entityId to download PDF's, remediate results, identity status update webhooks etc.

This will always be returned as the id value within the response body.

Note: The dataCheckId is not the id value that is returned within the results array.

Overall check result

To determine the overall result of a check you can use the 'status' value that is returned via the API.

The status value will correspond to one of the below:

ID	Name matching criteria
0	Legacy check (not expected to return)
1	Pending
2	Complete
3	Action required

Where a status of 2 is returned no further action is required as in the no match example above.

However, where a stats of 3 is returned you may wish to interpret the additional response data for an agent to determine if it is a positive or false positive match.

Interpreting detailed match information via the API is complex, you may want to consider downloading a the International Screening PDF or accessing the result via our magic links instead.

Obtaining detailed match information via the API

Where a match is returned we provide detailed match information for each profile via the API. Regardless of the type of match the format of the response will be the same however some fields may or may not be populated.

Within the results section we will return an array containing all matched profiles, these can be identified by the id returned at the top of the response body.

ID	Date of birth matching criteria
Id	Unique identifier, also referred to as the profileId.
firstName	The first name of the profile matched.
middleName	The middle name of the profile matched.
lastName	The last name of the profile matched.
isDeceased	A boolean value of true/false,
dateOfBirth	The date of birth of the profile matched.
gender	The gender of the profile matched.
pepTier	The pep tier of the profile matched.
profileImageBlobReference	The image blob reference of the profile matched.
addresses	An array containing address linked to the matched profile.
aliases	An array containing aliaseslinked to the matched profile.
contactDetails	An array containing contact details linked to the matched profile.
countries	An array containing countries linked to the matched profile.
datasets	An array containing datasets linked to the matched profile.
disqualifiedDirectors	An array containing disqualified director match information linked to the matched profile.
identifiers	An array containing identifiers linked to the matched profile.
nationalities	An array containing nationalities linked to the matched profile.
peps	An array containing pep match information linked to the matched profile.
notes	An array containing notes linked to the matched profile.
regulatoryEnforcements	An array containing law enforcement match information linked to the matched profile.
reputationalRiskExposures	An array containing adverse media match information linked to the matched profile.
sanctions	An array containing sanctions match information linked to the matched profile.
associatedProfiles	An array containing associated profiles linked to the matched profile.

It is important to note that Credas cannot always return all of the above information relating to a matched individual - we can only return the data that is provided as part of a sanctions filing etc.