Skip to main content

Response - Person

Overview of response structure for AML person check.

Overall response table

status| Type: Object
Explanation:

The overall status of the service check.

serviceSuspected| Type: Bool
Explanation:

True if a service found a record about the person under check.

checkSuccessful| Type: Bool
Explanation:

True if the check was completed without errors.

serviceFound| Type: Bool
Explanation:

True if a service was available for the given country.

serviceUsed| Type: Bool
Explanation:

True if a service was used during the check.

overallStatus| Type: String
Explanation:

A mapping string indicating the overall status of the check.

serviceName| Type: String
Explanation:

The name of the service that was used to check a person.

uid| Type: String
Explanation:

A unique identifier for a request. Unique only within one request scope.

errorMessage| Type: String
Explanation:

In case of an error during the checking process, a human-readable error message is provided.

data| Type: List
Explanation:

Data returned from services.

peps_and_sanctions_data| Type: Object
Explanation:

Result object from AML name check service.

name| Type: String
Explanation:

The name of the person in the service's database.

surname| Type: String
Explanation:

The surname of the person in the service's database.

nationality| Type: String
Explanation:

The nationality of the person in the service's database.

dob| Type: String
Explanation:

The date of birth of the person in the service's database.

suspicion| Type: String
Explanation:

The kind of suspicion. Possible values: PEPS, SANCTION, INTERPOL, OTHER.

reason| Type: String
Explanation:

The reason for the suspicion.

score| Type: Integer
Explanation:

Confidence coefficient that the information about the person is accurate.

lastUpdate| Type: String
Explanation:

Date when the record was last updated.

isPerson| Type: Bool
Explanation:

True if the record is about a person.

isActive| Type: Bool
Explanation:

True if the record is active.

checkDate| Type: String
Explanation:

Date and time when the AML name service was checked.

otherInformation| Type: String
Explanation:

Additional information, if any, from the database.

linkedDocument| Type: String
Explanation:

URL to a related source in the findings database.

negative_news_data| Type: Object
Explanation:

Result object from AML adverse media service.

title| Type: String
Explanation:

The title of the news article.

url| Type: String
Explanation:

URL pointing to the news article.

text| Type: String
Explanation:

A short extract of the news article text.

type| Type: String
Explanation:

The type of the news article.

checkDate| Type: String
Explanation:

Date and time when the AML news service was checked.

serviceGroupType| Type: String
Explanation:

The type of the service that was used. It is always AML.

Request example - DATA

{
"mode": "DATA",
"services": ["AML"],
"data": [
{
"probability": 100,
"name": "Alexander",
"surname": "Lukashenko",
"nameCheck": true,
"negativeNews": true
}
]
}

Request example - IDENTIFICATION

{
"mode": "IDENTIFICATION",
"services": ["AML"],
"data": [
{
"scanRef": "67093bbe-9bd0-11ed-93d0-025ad99a18e7",
"nameCheck": true,
"negativeNews": true
}
]
}

Response example

{
"AML": [
{
"status": {
"serviceSuspected": true,
"serviceUsed": true,
"serviceFound": true,
"checkSuccessful": true,
"overallStatus": "SUSPECTED"
},
"serviceName": "PilotApiAmlV2NameCheck",
"uid": "J9VHDU5MZT8OKU3XB6MY1VZR8",
"errorMessage": null,
"data": [
{
"reason": "BELARUS PROGRAM",
"listNumber": "UNKNOWN",
"suspicion": "SANCTION",
"isActive": true,
"checkDate": "2023-10-11 15:51:52",
"otherInformation": "",
"isPerson": true,
"score": 100,
"linkedDocument": "https://sanctionssearch.ofac.treas.gov/Details.aspx?id=9760",
"nationality": "BELARUS",
"surname": "LUKASHENKO",
"dob": "31 AUG 1954",
"lastUpdate": "2022-03-16",
"name": "ALEXANDER GRIGORYEVICH",
"listName": "OFAC"
},
{
"reason": "EU.5971.83 ",
"listNumber": "UNKNOWN",
"suspicion": "SANCTION",
"isActive": true,
"checkDate": "2023-10-11 15:51:52",
"otherInformation": "UNKNOWN",
"isPerson": true,
"score": 100,
"linkedDocument": "https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv%3AOJ.L_.2021.068.01.0029.01.ENG&toc=OJ%3AL%3A2021%3A068%3ATOC",
"nationality": "BELARUS",
"surname": "LUKASHENKO",
"dob": "1954",
"lastUpdate": "2022-07-08",
"name": "ALEXANDER GRIGORIEVICH",
"listName": "EU"
}
],
"serviceGroupType": "AML"
},
{
"status": {
"serviceSuspected": true,
"serviceUsed": true,
"serviceFound": true,
"checkSuccessful": true,
"overallStatus": "SUSPECTED"
},
"serviceName": "INHOUSE_ADVERSE_MEDIA",
"uid": "UXXYPB0I9WKSJYPQNV7GLGJAX",
"errorMessage": null,
"data": [
{
"title": "Why is one of Putin's closest allies defending Zelensky?",
"url": "https://www.msn.com/en-ca/news/world/why-is-one-of-putin-s-closest-allies-defending-zelensky/ss-AA1i1Fnc",
"text": "6 hours ago ... ... Alexander Lukashenko was planning. Provided by The Daily Digest ... fraud and abuse, securing our product, personalization essential to the ...",
"type": "NEGATIVE",
"checkDate": "2023-10-11 15:51:53"
},
{
"title": "US is pushing Russia 'toward using' nuclear weapons by arming ...",
"url": "https://www.observerbd.com/news.php?id=440550",
"text": "4 days ago ... Crime & Court · Budget · International · Business · Don't miss · Sports ... MINSK, Oct 7: Belarusian President Alexander Lukashenko said Friday ...",
"type": "NEGATIVE",
"checkDate": "2023-10-11 15:51:53"
}
],
"serviceGroupType": "AML"
}
]
}