API Reference
Log inSign up
v.1.7.2
v.1.7.2
  • Introduction
  • Integration
  • Sandbox and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
  • Clients
    • Create a client
    • Get a client
    • Update a client
    • Delete a client
    • List clients
    • Filtering clients
  • Addresses
    • Create an address
    • Get an address
    • Update an address
    • Delete an address
    • List addresses
    • Filtering addresses
  • Documents
    • Create a document
    • Get a document
    • Update a document
    • Upload image attachment
    • Download image attachment
    • Delete image attachment
    • Delete a document
    • List documents
    • Filtering documents
  • Live Photos
    • Upload a live photo
    • Get a live photo
    • Download live photo
    • Delete a live photo
    • List live photos
  • Checks
    • Create a check
    • Get a check
    • Update a check
    • Validate check outcome
    • List checks
    • Filtering checks
  • Risk Profile
    • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
  • Other Resources
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • Reports
      • Generate a client report
      • Generate a check report
    • SDK Tokens
      • Generate a token
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
Powered by GitBook
On this page
  • Run an AML Screening Check
  • Result object
  • Outcome
  • Breakdown
  • Sample Response

Was this helpful?

  1. Check types

AML Screening Check

Screen clients against ComplyCube's Sanctions & Watchlists, PEP, and Adverse Media database.

PreviousGet a risk profileNextDocument Check

Last updated 4 years ago

Was this helpful?

Run an AML Screening Check

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 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 first and last names for persons.

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:

  1. clear: Indicates ComplyCube found no matches.

  2. 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 is a subset of an Extensive AML Screening.

Breakdown

The breakdown comprises the following objects:

summary object

The outcome summary of the check. For each conducted check, the returned values include:

  1. clear: Indicates not matches were found on the corresponding database.

  2. attention: Indicates potential matches found on the corresponding database.

The 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 array

The 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.

Sample Response

{
	"id": "5ebe587ffd7de4000876118e",
	"entityName": "Viktor Shayman",
	"type": "extensive_screening_check",
	"clientId": "5ebe587bfd7de4000876118d",
	"status": "complete",
	"enableMonitoring": false,
	"result": {
		"outcome": "attention",
		"breakdown": {
			"summary": {
				"otherLists": {
					"associatedEntity": "attention",
					"organisedCrime": "clear",
					"financialCrime": "clear",
					"taxCrime": "clear",
					"corruption": "clear",
					"trafficking": "clear"
				},
				"pep": {
					"level2": "attention",
					"level3": "attention",
					"level1": "attention",
					"level4": "clear"
				},
				"watchlist": {
					"sanctionsLists": "clear",
					"otherOfficialLists": "clear",
					"warCrimes": "clear",
					"terror": "clear",
					"otherExclusionLists": "clear",
					"sanctionsControlAndOwnership": "clear"
				},
				"adverseMedia": {
					"environmentProduction": "clear",
					"socialLabour": "clear",
					"competitiveFinancial": "clear",
					"regulatory": "clear"
				}
			},
			"matches": [{
				"id": "5ebe5880fd7de4000876118f",
				"score": 100,
				"status": "attention",
				"details": {
					"entityName": "Viktor Vladimirovich Sheyman",
					"entityType": "person",
					"gender": "male",
					"deceased": false,
					"names": [{
							"type": "primary",
							"firstName": "Viktor",
							"middleName": "Vladimirovich",
							"lastName": "Sheyman",
							"entityName": "Viktor Vladimirovich Sheyman"
						},
						{
							"type": "localised_name",
							"entityName": "Віктар Уладзіміравіч Шэйман"
						},
						{
							"type": "localised_name",
							"entityName": "Шейман Виктор Владимирович"
						},
						{
							"type": "localised_name",
							"entityName": "Виктор Владимирович Шейман"
						},
						{
							"type": "alias",
							"firstName": "Victor",
							"middleName": "Vladimirovich",
							"lastName": "Sheyman",
							"entityName": "Victor Vladimirovich Sheyman"
						},
						{
							"type": "alias",
							"firstName": "Victor",
							"middleName": "Vladimirovich",
							"lastName": "Sheiman",
							"entityName": "Victor Vladimirovich Sheiman"
						}
					],
					"countries": [{
							"type": "Born in",
							"country": "BY"
						},
						{
							"type": "Citizenship",
							"country": "BY"
						},
						{
							"type": "Resident of",
							"country": "BY"
						},
						{
							"type": "Jurisdiction",
							"country": "BY"
						}
					],
					"birthPlaces": [
						"Grodno region,Belarus",
						"Hrodna region,Belarus",
						"Soltanishka, Voronovskovo,Belarus",
						"Soltanishki,Belarus",
						"Belarus"
					],
					"occupations": [{
							"type": "Primary Occupation",
							"category": "Senior Civil Servants-National Government",
							"title": "Head, President's Office",
							"fromDate": {
								"day": "21",
								"month": "01",
								"year": "2013"
							}
						},
						{
							"type": "Previous Roles",
							"category": "Senior Civil Servants-National Government",
							"title": "State Secretary, National Security Council",
							"fromDate": {
								"day": "20",
								"month": "03",
								"year": "2006"
							},
							"toDate": {
								"day": "08",
								"month": "07",
								"year": "2008"
							}
						},
						{
							"type": "Previous Roles",
							"category": "Senior Civil Servants-National Government",
							"title": "State Secretary, National Security Council",
							"fromDate": {
								"month": "12",
								"year": "1995"
							},
							"toDate": {
								"year": "2000"
							}
						},
						{
							"type": "Previous Roles",
							"category": "Senior Members of the Judiciary",
							"title": "Prosecutor General",
							"fromDate": {
								"year": "2000"
							},
							"toDate": {
								"month": "11",
								"year": "2004"
							}
						},
						{
							"type": "Previous Roles",
							"category": "Senior Civil Servants-National Government",
							"title": "Presidential Aide for Special Missions",
							"fromDate": {
								"month": "01",
								"year": "2013"
							},
							"toDate": {
								"day": "21",
								"month": "01",
								"year": "2013"
							}
						},
						{
							"type": "Previous Roles",
							"category": "Senior Civil Servants-National Government",
							"title": "State Secretary, National Security Council",
							"fromDate": {
								"day": "05",
								"month": "08",
								"year": "1994"
							},
							"toDate": {
								"month": "10",
								"year": "1995"
							}
						},
						{
							"type": "Previous Roles",
							"category": "National Government Ministers",
							"title": "Minister of Interior",
							"fromDate": {
								"month": "10",
								"year": "1995"
							},
							"toDate": {
								"month": "12",
								"year": "1995"
							}
						},
						{
							"type": "Previous Roles",
							"category": "Senior Civil Servants-National Government",
							"title": "Head, Presidential Administration",
							"fromDate": {
								"month": "11",
								"year": "2004"
							},
							"toDate": {
								"day": "04",
								"month": "01",
								"year": "2006"
							}
						}
					],
					"dates": [{
						"type": "Date of Birth",
						"date": {
							"day": "26",
							"month": "05",
							"year": "1958"
						}
					}],
					"references": [{
							"source": "EC 2015/1949 Belarus List",
							"fromDate": {
								"day": "29",
								"month": "10",
								"year": "2015"
							}
						},
						{
							"source": "EC (CFSP) 2015/1957 Belarus List",
							"fromDate": {
								"day": "29",
								"month": "10",
								"year": "2015"
							}
						},
						{
							"source": "EC 2016/276 Belarus List",
							"fromDate": {
								"day": "25",
								"month": "02",
								"year": "2016"
							}
						},
						{
							"source": "EC (CFSP) 2016/280 Belarus List",
							"fromDate": {
								"day": "25",
								"month": "02",
								"year": "2016"
							}
						},
						{
							"source": "French Economy Ministry - EU and UN Asset Freezing Measures",
							"fromDate": {
								"day": "30",
								"month": "07",
								"year": "2017"
							}
						}
					],
					"addresses": [{
						"line": "Karl Marx, 38",
						"city": "Minsk",
						"postalCode": "220016",
						"country": "BY"
					}],
					"identifications": [{
							"type": "OFAC Program ID",
							"value": "BELARUS"
						},
						{
							"type": "OFAC Unique ID",
							"value": "9769"
						},
						{
							"type": "EU Sanctions Programme Indicator",
							"value": "BLR"
						},
						{
							"type": "EU Consolidated Electronic List ID",
							"value": "3411"
						},
						{
							"type": "HM Treasury Group ID",
							"value": "8904"
						},
						{
							"type": "SECO SSID",
							"value": "4596"
						}
					],
					"images": [
						"https://naviny.com/c/b0/b06235bad25e89f92f5ffe89676e8589.jpg",
						"http://pmrb.gov.by/images/shejman.jpg"
					],
					"classifications": {
						"pep": [
							"level2",
							"level1"
						]
					}
				},
				"breakdown": [{
					"fieldName": "name",
					"riskWeight": 100,
					"breakdowns": [],
					"fieldValue": "viktor uladzimiravich sheyman",
					"score": 93,
					"riskWeightedScore": 93,
					"normalisedScore": 100
				}]
			}]
		}
	},
	"createdAt": "2020-05-15T08:53:20.307Z",
	"updatedAt": "2020-05-15T08:53:20.307Z"
}

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 .

create a check
client
Learn about AML Screening Checks
coverage scope
service page
here
two-letter country ISO code
two-letter country ISO code
summary object's
structured date
structured date
structured date
structured date
structured date