Person Compliance Check
POST/compliance/person-check
This endpoint performs a person compliance check (of an individual).
The Compliance check process includes the following components:
- Check of Individual Blacklist of a given acceptance point / market place operator or by Brand
- Check of different sanction lists, can be selected individually
- Check of PEP lists (only if required by Acceptance point / Market place or otherwise PEP is excluded from checks)
- Check of different law enforcement lists, can be selected individually.
In case of exact match, the compliance check is interrupted, and the system delivers a RED traffic light back to the request issuing system.
The following section will describe the procedure and results of a person compliance check and can be analogously applied to a company compliance check (see Company Compliance Check section).
Call this API method and specify as much individual-related information as possible, e.g., customer name, address, birthdate, etc.
The customerId
is an optional request parameter, and can be acquired by contacting your Product Solution Specialist.
Request
Header Parameters
Must be application/json
Must be be en-US
The origin of the request
The client making the request
- application/json
Body
required
Optional customer ID.
First name of the individual.
Last name of the individual.
Possible values: <= 127 characters
First line of the address.
Possible values: <= 10 characters
House number.
Possible values: <= 10 characters
Postal code.
Possible values: <= 64 characters
City of residence.
Possible values: <= 2 characters
Country code (ISO 3166-1 alpha-2 format).
Possible values: <= 10 characters
Date of birth in YYYY-MM-DD format.
Possible values: <= 6 characters
, [MALE
, FEMALE
]
Gender of the individual.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Successful response with compliance data.
- application/json
- Schema
- Example (from schema)
- Green Response
- Red Response
Schema
GREEN
: No hit.YELLOW
: Unsure hit.RED
: Hit.SL
: Sanctions ListBL
: BlacklistPEP
: Politically Exposed Person
Due to regulatory requirements, a person or company must not be part of this list.Array [
]
complianceData
object
ID of the compliance check archive
Possible values: [GREEN
, YELLOW
, RED
]
Result of the compliance check:
Possible values: [SL
, BL
, PEP
]
Type of hit:
Indicates if manual review is required
details
object[]
Details of any matches found
Name of the matched individual
Birthdate of the matched individual
Contains diagnostic or tracking metadata returned with the API response. It is primarily used for support, logging and troubleshooting purposes.
Country of origin of the matched individual
Country of activity of the matched individual
Match rule applied
Data pool from which the match was found
Authority that published the match
Key for the match
Score of the match
Type of the match
List from which the match was found
If the check result has been manually added to the compliance white/black list, the parameter listHit
is set to True
.
Date and time of the request
Response code of the compliance check
Description of the response
additionalInformation
object
Contains diagnostic or tracking metadata returned with the API response. It is primarily used for support, logging and troubleshooting purposes.
ID of the request
{
"complianceData": {
"archiveId": "string",
"trafficLight": "GREEN",
"hitType": "SL",
"manualReview": true,
"details": [
{
"name": "string",
"birthdate": "string",
"additionalInformation": "string",
"countryOfOrigin": "string",
"countryOfActivity": "string",
"match_rule": "string",
"data_pool": "string",
"PUBLICATION_AUTHORITY": "string",
"matchKey": "string",
"score": "string",
"type": "string",
"list": "string"
}
],
"listHit": true
},
"requestDateTime": "2024-07-29T15:51:28.071Z",
"responseCode": "string",
"responseDescription": "string",
"additionalInformation": {
"requestId": "string"
}
}
Green response example
{
"complianceData": {
"archiveId": "4737062516381240",
"trafficLight": "GREEN",
"manualReview": false,
"details": [],
"listHit": false
},
"requestDateTime": "2023-06-02T15:57:46.000Z",
"responseCode": "0000",
"responseDescription": "Successful execution.",
"additionalInformation": {
"requestId": "7d5c6d9497564c1ea99e5576936fc887"
}
}
Red response example
{
"complianceData": {
"archiveId": "4274062516381248",
"trafficLight": "RED",
"hitType": "SL",
"manualReview": false,
"details": [
{
"name": "Ramzan Akhmadovitch KADYROV",
"birthdate": "19761005",
"additionalInformation": "EU reference number: EU.XXX.XXXX .... Birthdates: 1976-10-05",
"countryOfOrigin": "RUS",
"countryOfActivity": "RUS",
"match_rule": "R2",
"data_pool": "aml-rep-info4c-sanction-list",
"PUBLICATION_AUTHORITY": "European Commission, the EU Credit Sector Federations",
"matchKey": "10151007415",
"score": "99",
"type": "European Commission, the EU Credit Sector Federations, European Union Lists",
"list": "EU Financial Sanctions"
}
],
"listHit": false
},
"requestDateTime": "2023-06-02T15:59:42.000Z",
"responseCode": "0000",
"responseDescription": "Successful execution.",
"additionalInformation": {
"requestId": "b3c4174639e349a4a7cb40f42ab02f38"
}
}
Bad Request
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Value out of bounds. Value must be between 1 and 100",
"code": "value_out_of_bounds",
"property": "someField",
"context": {
"minimum": 1,
"maximum": 100
}
}
]
}
Unauthenticated
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You are not authenticated to perform this request.",
"code": "unauthorized"
}
]
}
Forbidden
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "You do not have permissions to perform this request.",
"code": "forbidden"
}
]
}
Not Found
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Resource not found.",
"code": "not_found"
}
]
}
Internal Server Error
For error handling, please refer to this section.
- application/json
- Schema
- Example (from schema)
- Example
Schema
- MOD1
- MOD2
Array [
]
errorDetails
object
message
object
oneOf
string
string
{
"error": "string",
"errorDetails": {
"context": {},
"gatewayDescription": "string",
"paymentProviderDescription": "string"
},
"message": "string"
}
{
"traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
"errors": [
{
"message": "Internal server error."
}
]
}