International screening - run a new check | API

To perform a new international screening check you must send a POST request to the /api/v2/ci/entities/{entityId}/data-checks/sanctions-and-peps endpoint.

You must specify an entityId as part of this request.  If you do not have an existing Entity that you wish to use you must first create an Entity - see the Create a new Entity page for more details on this.

As part of your request you must specify a request body, such as:

{

  "firstName": "string",

  "middleNames": "string",

  "surname": "string",

  "datasets": [

    1

  ],

  "dateOfBirth": "2023-09-05T08:51:43.282Z",

  "useAllCountries": true,

  "countries": [

    "string"

  ],

  "addToWatchList": true,

  "watchListPeriodType": 0,

  "watchListPeriod": 0,

  "dateOfBirthMatching": 0,

  "nameMatching": 0,

  "useAllPepTiers": true,

  "includePepTiers": [

    0

  ]

}

Request body values

firstName - mandatory

This is the first name of the individual you are seeking to verify.

middleNames - nullable

This is the middle name(s)of the individual you are seeking to verify.

surname - mandatory

This is the surname of the individual you are seeking to verify.

datasets - mandatory

This value determines the datasets that are used as part of the datacheck - the relevant values should be provided as an array e.g. [1,2,3,4].

The following values can be used:

dateOfBirth - mandatory if used for matching, otherwise nullable 

This is the date of birth of the individual you are seeking to verify - it must be provided in the format specified in the example body. If date of birth is not used for matching this field is nullable.

useAllCountries - mandatory 

Determines the countries included as part of the search. This is a boolean value so must be set as true or false. 

countries - nullable

Determines the countries included as part of the search if useAllCountries is set to false. This can be null if useAllCountries is set to true. 

addToWatchList

Determines if the individual is added to ongoing monitoring. This is a Boolean value so must be set as true or false. 

watchListPeriodType

Determines the period type for watchlist, this field is mandatory if addToWatchList is set to true. 

The value must be set as one of the following:

This value works in conjunction with watchListPeriod e.g. a watchListPeriodType of 3 and a watchListPeriod of 1 = 1 year of ongoing monitoring .

watchListPeriod

This is an integer value that determines the period of ongoing monitoring, this field is mandatory if addToWatchList is set to true.

This value works in conjunction with watchListPeriodType e.g. a watchListPeriodType of 2 and a watchListPeriod of 6 = 6 months ongoing monitoring.

dateOfBirthMatching - mandatory

Determines the method of date of birth matching used as part of the datacheck. The value must be set as one of the below:

nameMatching - mandatory

Determines the method of name matching used as part of the datacheck. The value must be set as one of the below:

useAllPepTiers - mandatory

Determines if all pep tiers are used as part of the datacheck. This is a boolean value so must be set as true or false.

includePepTiers - nullable

Determines the PEP tiers used if useAllPepTiers is set to false. If useAllPepTiers is set to true this field is nullable.

The value must set as an array using the below values if useAllPepTiers is false: