AML Screening Check
Last updated
Last updated
By using this integration you will be able to screen your clients against against ComplyCube's Sanctions & Watchlists, PEP, and Adverse Media database.
You can choose between two check types
standard_screening_check
extensive_screening_check
You can configure users' input that will be send to comply cube in order to get the most of the verifications.
| Field | Description | Type | Required |
|---|---|---|---|
The more data you provide for a client, the more accurate the AML Screening Check results. This will ultimately reduce the number of potential 'false positive' matches.
It is highly recommended that you provide the client's date of birth in addition to the first and last names of persons.
| Field | Description | Type | Required |
|---|---|---|---|
| Field | Description | Type | Required |
|---|---|---|---|
| Field | Description | Type | Required |
|---|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
| Attribute | Type | Description |
|---|---|---|
The client's email address.
string
Yes
mobile
The client's mobile number.
string
No
telephone
The client's telephone number.
string
No
joinedDate
The date and time when the client was registered with you. This is relevant for users that migrate existing customers.
string (format YYYY-MM-DD)
No
Primary details for a client of type person
object
Yes if client is of type person
Primary details for a client of type company
object
Yes if client is of type company
Primary details of a client's address
object
Yes if proof of address check is selected
firstName
The client's first name.
string
Yes (required when client is a person)
middleName
The client's middle name.
string
No
lastName
The client's last name.
string
Yes (required when client is a person)
dob
The client's date of birth.
string (format YYYY-MM-DD)
No
gender
The client's gender.
string (possible values include: male, female, other)
No
nationality
The client's nationality.
string (2 letter country ISO code)
No
birthCountry
The client's birth country.
string (2 letter country ISO code)
No
ssn
The client's SSN (Social Security Number). This is for US clients.
string
No
socialInsuranceNumber
The client's Social Insurance Number.
string
No
nationalIdentityNumber
The client's National Identity Number.
string
No
taxIdentificationNumber
The client's Tax Identification Number (TIN).
string
No
name
Name of the company.
string
Yes (required if client is company)
website
Website of the company.
string
No
registrationNumber
Registration number of the company.
string
No
incorporationCountry
Country where the company is incorporated.
string (2 letter country ISO code)
No
incorporationType
Type of incorporation of the company.
string (possible values include:
sole_proprietorship
private_limited_company
public_limited_company
limited_partnership
holding_company
non_government_organisation
statutory_company
subsidiary_company
unlimited_partnership
charitable_incorporated_organisation
chartered_company)
No
type
Type of address.
string (possible values include:
main
alternative
other)
No
propertyNumber
Property number (if applicable).
string
No
buildingName
Building name (if applicable).
string
No
line
Address line.
string
Yes
city
City in the address.
string
Yes
state
State in the address.
string
No
postalCode
Postal code of the address.
string
No
country
Country of the address. (2 letter country ISO code)
string (2 letter country ISO code)
Yes
fromDate
Start date of residing at this address.
string (format YYYY-MM-DD)
No
toDate
End date of residing at this address.
string (format YYYY-MM-DD)
No
state
String
State of the AML screening check (e.g., "FINISHED").
outcome
String
Outcome of the AML screening check (e.g., "attention").
breakdown
Object
Breakdown of the AML screening check results.
summary
Object
Outcome summary of the check.
matches
Array
List of match objects containing details of entities that matched with the screened client's details.
id
String
Unique identifier for a match.
score
Number
Match score calculated by ComplyCube. A higher score indicates a closer match.
status
String
Match status.
details
Object
Details of a match.
breakdown
Array
Breakdown of the match, including risk-weighted scores and field values.
pep
Array
Array of PEP classifications.
images
Array
Array of URIs of images for the match.
type
String
Type of name (primary, alias, localised_name).
firstName
String
First name of the match.
middleName
String
Middle name of the match.
lastName
String
Last name of the match.
entityName
String
Complete name of the match (returned for person and company).
type
String
Type of occupation.
category
String
Category of the occupation.
title
String
Role title.
fromDate
Object
Start date of the occupation (structured date).
toDate
Object
End date of the occupation (structured date).
type
String
Type of date.
date
Object
Structured date.
line
String
Line of the address.
city
String
City or town of the address.
postalCode
String
Post or zip code of the client's address.
country
String
Country of the address (two-letter country ISO code).
source
String
Source name.
fromDate
Object
Start date of the source's validity (structured date).
toDate
Object
End date of the source's validity (structured date).
type
String
Type of identification.
value
String
Value or reference associated with the identification.
dates
Array
Array of value pair objects covering important dates associated with the match.