AML Screening Check
Screen clients against ComplyCube's Sanctions & Watchlists, PEP, and Adverse Media database.
Last updated
Was this helpful?
Screen clients against ComplyCube's Sanctions & Watchlists, PEP, and Adverse Media database.
Last updated
Was this helpful?
To run an AML Screening Check, you must with type
set to:
1. standard_screening_check
, or
2. extensive_screening_check
Also, a valid clientId
is required. Optionally, the enableMonitoring
can be passed to indicate whether continuous monitoring should be enabled or not. When enableMonitorin
is not provided, it defaults to false.
For a 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.
.
The result
object is only returned when the status of the check is complete
. It has two components - outcome
and breakdown
.
The outcome attribute represents the overall check result. Returned values include:
clear
: Indicates ComplyCube found no matches.
attention
: Indicates ComplyCube found potentials matches.
The breakdown comprises the following objects:
summary
objectThe outcome summary of the check. For each conducted check, the returned values include:
clear
: Indicates not matches were found on the corresponding database.
attention
: Indicates potential matches found on the corresponding database.
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
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
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
names
: An array of name
objects that contain all known aliases for the match. The name
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 for person
and company
.
countries
: An array of value pair objects covering known associated countries for the match.
type
: The type of association.
birthPlaces
: An array of strings that contain all known birthplaces for the match.
gender
: The gender of the match, if of type person
. Values include:
male
female
other
deceased
: A boolean that indicates whether the match is deceased.
occupations
: An array of occupation
objects that contain all known occupation for the match. This is only returned when the match is a Politically Exposed Person (PEP). The occupation
object has the following attributes:
type
: The type of occupation.
category
: The category of the occupation.
title
: The role title.
dates
: An array of value pair objects covering important dates associated with the match.
type
: The type of date.
addresses
: An array of address
objects that contain known associated countries for the match. The address
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.
references
: An array of reference
objects that contain list references for the match. The reference
object has the following attributes:
source
: The source name.
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.
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 .
pep
: Contains the outcome for checks against the Politically Exposed Persons (PEP) database, with matches classified as per the levels described .
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 key.
country
: The country. This will be the .
fromDate
: The occupation start date. This will be a .
toDate
: The occupation end date. This will be a .
data
: The date. This will be a .
country
: The country of the address. This will be the .
fromDate
: The start date of the source's validity. This will be a .
toDate
: The end date of the source's validity. This will be a .