Performs An AML Search For An Individual And Saves The Results To The Database

A request requires a name, or first name and last name, at least one valid dataset 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.

SecuritybearerToken
Request
Request Body schema: application/json
countryCodes
Array of strings or null

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

threshold
required
integer <int32>

Hits with scores below the chosen value will not be shown.
Must be one of 75, 80, 85, 90, 95, or 100

name
string or null

Required if FirstName and LastName are not provided

firstName
string or null

If firstName is provided then lastName must also be provided

middleName
string or null

middleName is optional, valid along with firstName and lastName only

lastName
string or null

If LastName is provided then FirstName must also be provided

dateOfBirth
string or null <date>

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

gender
string or null

Define the gender of the individual you are searching for. Available values are male and female.

Enum: "male" "female"
pepTiers
Array 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.

Enum: "pepTier1" "pepTier2" "pepTier3" "byAssociation"
datasets
required
Array 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

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

post/compliance/kyc-protect/searches/individuals
Request samples
application/json
{
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "name": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "dateOfBirth": "2019-08-24",
  • "gender": "male",
  • "pepTiers": [
    ],
  • "datasets": [
    ]
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "countryCodes": [
    ],
  • "threshold": 0,
  • "type": "string",
  • "datasets": [
    ],
  • "status": "string",
  • "riskRating": "string",
  • "assignedToUserId": 0,
  • "assignedUser": "string",
  • "createdById": 0,
  • "createdBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedById": 0,
  • "modifiedBy": "string",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "note": "string",
  • "totalHitCount": 0,
  • "truePositiveHitsCount": 0,
  • "falsePositiveHitsCount": 0,
  • "undecidedHitsCount": 0,
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "gender": "string",
  • "dateOfBirth": "2019-08-24",
  • "pepTiers": [
    ],
  • "scheduleId": "string"
}