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:
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 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.
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.
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 not 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:sanctionsListterrorwarCrimesotherOfficialListsotherExclusionListssanctionsControlAndOwnership
pep: Contains the outcome for checks against the Politically Exposed Persons (PEP) database, with matches classified as per the levels described here.level1level2level3level4
adverseMedia: Contains the outcome for checks against the Adverse Media database, with matches classified with one or more of the following values:competitiveFinancialregulatory:environmentProductionsocialLabour
otherLists: Contains the outcome for checks conducted against other prudent lists, with matches classified with one or more of the following values:taxCrimecorruptiontraffickingfinancialCrimeorganisedCrimeassociatedEntity
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:personcompany
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 ofnameobjects that contain all known aliases for the match. Thenameobject 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 forpersonandcompany.
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:malefemaleother
deceased: A boolean that indicates whether the match is deceased.
occupations: An array ofoccupationobjects that contain all known occupation for the match. This is only returned when the match is a Politically Exposed Person (PEP). Theoccupationobject 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 ofaddressobjects that contain known associated countries for the match. Theaddressobject 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 ofreferenceobjects that contain list references for the match. Thereferenceobject 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
Was this helpful?