> For the complete documentation index, see [llms.txt](https://docs.transactionlink.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.transactionlink.io/docs/v1/integrations/complycube/aml-screening-check.md). # AML Screening Check ### What kind of data I will get By using this integration you will be able to screen your clients against against ComplyCube's Sanctions & Watchlists, PEP, and Adverse Media database. ### Integration Scope You can choose between two check types * `standard_screening_check` * `extensive_screening_check` ### Input You can configure users' input that will be send to comply cube in order to get the most of the verifications.
FieldDescriptionTypeRequiredDescriptionRequired
emailThe client's email address.stringYesEmail address of the client.Yes
mobileThe client's mobile number.stringNoClient's mobile phone number.No
telephoneThe client's telephone number.stringNoClient's telephone number.No
joinedDateThe date and time when the client was registered with you. This is relevant for users that migrate existing customers. string (format YYYY-MM-DD)NoDate when the client joined (YYYY-MM-DD).No
personDetailsPrimary details for a client of type personobjectYes if client is of type personDetails about the individual client.
companyDetailsPrimary details for a client of type companyobjectYes if client is of type companyDetails about the client's company.
addressPrimary details of a client's addressobjectYes if proof of address check is selectedAddress information related to the client.Required when proof of address check selected
### PersonDetails
FieldDescriptionTypeRequiredDescription
firstNameThe client's first name. stringYes (required when client is a person)First name of the individual.
middleNameThe client's middle name.stringNoMiddle name of the individual.
lastNameThe client's last name.stringYes (required when client is a person)Last name of the individual.
dobThe client's date of birth.string (format YYYY-MM-DD)NoDate of birth (YYYY-MM-DD).
genderThe client's gender.string (possible values include: male, female, other)NoGender of the individual.
nationalityThe client's nationality.string (2 letter country ISO code)NoNationality of the individual.
birthCountryThe client's birth country.string (2 letter country ISO code)NoCountry of birth of the individual.
ssnThe client's SSN (Social Security Number). This is for US clients.stringNoSocial Security Number (if applicable).
socialInsuranceNumberThe client's Social Insurance Number. stringNoSocial Insurance Number (if applicable).
nationalIdentityNumberThe client's National Identity Number.stringNoNational Identity Number (if applicable).
taxIdentificationNumberThe client's Tax Identification Number (TIN).stringNoTax Identification Number (if applicable).
### CompanyDetails | Field | Description | Type | Required | | -------------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | 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:

  1. sole\_proprietorship
  2. private\_limited\_company
  3. public\_limited\_company
  4. limited\_partnership
  5. holding\_company
  6. non\_government\_organisation
  7. statutory\_company
  8. subsidiary\_company
  9. unlimited\_partnership
  10. charitable\_incorporated\_organisation
  11. chartered\_company)
| No | ### Address | Field | Description | Type | Required | | -------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | | type | Type of address. |

string (possible values include:

| 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 | {% hint style="info" %} 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. {% endhint %} {% hint style="info" %} It is highly recommended that you provide the client's **date of birth** in addition to the first and last names of **persons**. {% endhint %} ### Input Example ```json { "email": "test@transactionlink.io", "personDetails": { "firstName": "John", "lastName": "Doe", "dob": "1990-01-01", "nationality": "GB" }, "address": { "line": "Polna 12/3", "city": "Warsaw", "country": "PL" } } ``` ### Output #### Checks Result | Attribute | Type | Description | | --------- | ------ | ------------------------------------------------------- | | 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. | #### Breakdown | Attribute | Type | Description | | --------- | ------ | ----------------------------------------------------------------------------------------------------- | | 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. | #### Match | Attribute | Type | Description | | --------- | ------ | ------------------------------------------------------------------------------ | | 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. | #### Classifications | Attribute | Type | Description | | --------- | ----- | ----------------------------- | | pep | Array | Array of PEP classifications. | #### Images | Attribute | Type | Description | | --------- | ----- | -------------------------------------- | | images | Array | Array of URIs of images for the match. | #### Name | Attribute | Type | Description | | ---------- | ------ | ------------------------------------------------------------- | | 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). | #### Occupation | Attribute | Type | Description | | --------- | ------ | ----------------------------------------------- | | 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). | #### Date | Attribute | Type | Description | | --------- | ------ | ---------------- | | type | String | Type of date. | | date | Object | Structured date. | #### Address | Attribute | Type | Description | | ---------- | ------ | ----------------------------------------------------- | | 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). | #### Reference | Attribute | Type | Description | | --------- | ------ | ------------------------------------------------------ | | 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). | #### Identification | Attribute | Type | Description | | --------- | ------ | ------------------------------------------------------ | | type | String | Type of identification. | | value | String | Value or reference associated with the identification. | #### Dates | Attribute | Type | Description | | --------- | ----- | ------------------------------------------------------------------------------- | | dates | Array | Array of value pair objects covering important dates associated with the match. | ```json { "complyCube": { "amlScreening": [ { "client": { "id": "5eb04fcd0f3e360008035eb1", "type": "person", "email": "victor.sheyman@example.com", "mobile": "+12345678910", "telephone": "+12 345678910", "joinedDate": "2020-01-01", "personDetails": { "firstName": "Victor", "lastName": "Sheyman", "dob": "1990-01-01", "nationality": "GB" }, "createdAt": "2020-01-04T17:24:29.146Z", "updatedAt": "2020-01-04T17:24:29.146Z" }, "checksResult": { "amlScreeningCheck": { "state": "FINISHED", "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 } ] } ] } } } } ] } } ```