Download A PDF File For An Individual AML Screening

Request

A request requires a name, or first name and last name, at least one valid dataset, at least one valid countrycode and a threshold. Length of name or combination of first name, middle name and last name must not exceed 200 characters. If user is providing first name, middle name and last name combination, the max characters limit includes the formatted name in this format lastname, firstname middlename. User will be deducted 1 credit for each search.

Security

bearerToken

Bodyapplication/json

countryCodesArray of strings or null

List of Two-letter country code ISO-3166-2.

thresholdinteger, (int32)

Must be one of 75, 80, 85, 90, 95, or 100

namestring or null

Required if FirstName and LastName are not provided example: Google Inc Max 200 characters allowed.

firstNamestring or null

If FirstName is provided then LastName must also be provided

middleNamestring or null

Middle name is optional, valid along with Firstname and LastName only

lastNamestring or null

If LastName is provided then FirstName must also be provided

dateOfBirthstring or null, (date)

Date YYYY-MM-DD or YYYY format. Must be after 1900 and not in the future.

genderstring or null

Define the gender of the individual you are searching for.

pepTiersArray of strings or null

When searching the PEP dataset, define what tiers of the PEP profiles should be included in the results.

PEP Tier 1 - Indicates senior Roles
PEP Tier 2 - Middle-Ranking
PEP Tier 3 - Junior Officials

If the PEP Dataset is NOT included on the list of searched datasets, then this value is ignored. The PEP Tier filter does not apply to PEP-LINKED Profiles.

datasetsArray of strings or null

Specifies which datasets will be searched

PEP - Politically Exposed Persons (All)
PEP-CURRENT - Only current PEPs
PEP-FORMER Only former PEPs
PEP-LINKED - Only linked PEPs (PEP by Association)
SAN - Sanctioned (All)
SAN-CURRENT - Only current Sanctions
SAN-FORMER - Only former Sanctions
INS - Insolvency
AM - Averse Media
POI - Profile of Interest
ENF - Enforcement
DD - Disqualified Director

curl -i -X POST \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/searches/individuals/download \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "countryCodes": [
      "string"
    ],
    "threshold": 0,
    "name": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "dateOfBirth": "2019-08-24",
    "gender": "string",
    "pepTiers": [
      "string"
    ],
    "datasets": [
      "string"
    ]
  }'

Responses

Success

Bodyapplication/json

searchIdstring, (uuid)

Id of the search

downloadUrlstring

Url of the file to download

fileNamestring

Name of the file

expiresAtstring, (date-time)

Date and time when the url will expire

Response

{
  "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
  "downloadUrl": "string",
  "fileName": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}