AML Screening Check
Screen clients against ComplyCube's Sanctions & Watchlists, PEP, and Adverse Media database.
Run an AML screening check
To run an AML Screening Check, you must create a check with type
set to:
standard_screening_check
, orextensive_screening_check
For a client of type person
, you can run an AML Screening Check when the firstName
and lastName
are present. For a company, only the name
is required.
Learn about AML Screening Checks.
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.
Check request
Attribute | Type | Description |
---|---|---|
| string | The ID of the client associated with this check. (Required) |
| string | The type of AML screening check. Valid values include:
(Required) |
| boolean | Determines whether continuous monitoring is enabled. When not provided, it defaults to false. (Optional) |
| object | The optional settings for the check. Also, see the options object below. (Optional) |
The options
object
options
object Attribute | Description |
---|---|
| Type: The scope of lists to search as part of a screening check. See the When this attribute is not provided, we will search all eligible lists. |
| Type: The name matching technique to apply:
When this attribute is not provided, we will use fuzzy name matching. |
| Type: The match classifications to include as part of a screening check. Valid values include:
When this attribute is not provided, we will conduct a search against all eligible classifications. |
The screeningListsScope
object
screeningListsScope
object Attribute | Description |
| Type: The criteria to apply to the lists when performing a screening search. Valid values include:
When this attribute is not provided, it will default to |
| Type: The lists to include or exclude as part of the screening search. |
Example requests
Simple request
Request with optional attributes
Result object
The result
object is only returned when the status of the check is complete
. It has two components - outcome
and breakdown
.
Outcome
The outcome attribute represents the overall check result. Returned values include:
clear
: Indicates ComplyCube found no matches.attention
: Indicates ComplyCube found potentials matches.
All summary results will either return clear
, attention
, or not_processed
. The value not_processed
is expected to return on Standard AML Screening checks, as the service coverage scope is a subset of an Extensive AML Screening.
Breakdown
The breakdown comprises the following objects:
summary
object
summary
objectThe outcome summary of the check. For each conducted check, the returned values include:
clear
: Indicates no matches were found on the corresponding database.attention
: Indicates potential matches found on the corresponding database.not_processed
: Returned when the corresponding database has not been checked. This is to be expected for Standard AML Screening checks, as the coverage scope is a subset of an Extensive AML Screening check as highlighted on the service page.
The summary
object has the following constituents:
summary
object has the following constituents:watchlist
: Contains the outcome for checks against the Sanctions & Watchlist database, with matches classified with one or more of the following values:sanctionsList
terror
warCrimes
otherOfficialLists
otherExclusionLists
sanctionsControlAndOwnership
pep
: Contains the outcome for checks against the Politically Exposed Persons (PEP) database, with matches classified as per the levels described here.level1
level2
level3
level4
adverseMedia
: Contains the outcome for checks against the Adverse Media database, with matches classified with one or more of the following values:competitiveFinancial
regulatory
:environmentProduction
socialLabour
otherLists
: Contains the outcome for checks conducted against other prudent lists, with matches classified with one or more of the following values:taxCrime
corruption
trafficking
financialCrime
organisedCrime
associatedEntity
matches
array
matches
arrayThe matches array contains a list of match objects, which contain the details of the entity that matched with the screened client's details. For each match
object has the following constituents:
id
: The unique identifier for a match.score
: The match score, as calculated by ComplyCube. A higher score indicates a closer match.details
: This contains the details of a match.entityName
: The full name of the matched entity.
entityType
: The type of matched entity. Values include:person
company
classifications
: This contains key and string array pairs that classify the match. Possible values of the key and associated string array will align with the summary object's key.
names
: An array ofname
objects that contain all known aliases for the match. Thename
object has the following attributes:type
: The type of name. Values include:primary
: The Latin name by which entity is primarily or legally known as.alias
: An alias by which the entity is also known as.localised_name
: The entity name as transcribed or known in languages or scripts such as Arabic, Cyrillic, Sanskrit, and so forth.
firstName
: The match's first name.middleName
: The match's middle name.lastName
: The match's last name.entityName
: The match's complete name, returned forperson
andcompany
.
countries
: An array of value pair objects covering known associated countries for the match.type
: The type of association.country
: The country. This will be the two-letter country ISO code.
birthPlaces
: An array of strings that contain all known birthplaces for the match.
gender
: The gender of the match, if of typeperson
. Values include:male
female
other
deceased
: A boolean that indicates whether the match is deceased.
occupations
: An array ofoccupation
objects that contain all known occupations for the match. This is only returned when the match is a Politically Exposed Person (PEP). Theoccupation
object has the following attributes:type
: The type of occupation.category
: The category of the occupation.title
: The role title.fromDate
: The occupation start date. This will be a structured date.toDate
: The occupation end date. This will be a structured date.
dates
: An array of value pair objects covering important dates associated with the match.type
: The type of date.data
: The date. This will be a structured date.
addresses
: An array ofaddress
objects that contain known associated countries for the match. Theaddress
object has the following attributes:line
: The line of the address.city
: The city or town of the address.postalCode
: The post or zip code of the client's address.country
: The country of the address. This will be the two-letter country ISO code.
references
: An array ofreference
objects that contain list references for the match. Thereference
object has the following attributes:source
: The source name.fromDate
: The start date of the source's validity. This will be a structured date.toDate
: The end date of the source's validity. This will be a structured date.
identifications
: An array of value pair objects covering known identifications associated with the match.type
: The type of identification.value
: The value or reference associated with the identification.
images
: An array of strings that contain URIs of images for the match.
Sample response
Last updated