Compliance Checks API

Last changes: 02-29-2024

With our Compliance Services we are offering the functionalities required to comply with regulatory requirements in regards to online sales.

The Compliance check process includes 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.

Perform a Compliance Check

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 the Person Compliance Check API method and specify as much individual-related information as possible, e.g. customer name, address, birthdate, etc.

Person Compliance Check Request

Path:: POST {baseURL}/compliance/person-check
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "customerId": "100001",
    "firstName": "Mohamed",
    "lastName": "ABU DHESS",
    "addressLine1": "Holdenweg",
    "number": "76",
    "postCode": "45143",
    "city": "Essen",
    "countryCode": "DE",
    "dateOfBirth": "1965-01-01",
    "gender": "MALE"
}

Person Compliance Check Response (GREEN)

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "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"
    }
}

Person Compliance Check Response (RED)

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
  "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"
      },
      {
        "name": "RAMZAN AKHMADOVITCH KADYROV",
        "birthdate": "19761005",
        "additionalInformation": "Other Information: (UK Sanctions List Ref):...",
        "countryOfOrigin": "RUS",
        "countryOfActivity": "RUS",
        "match_rule": "R2",
        "data_pool": "aml-rep-info4c-sanction-list",
        "PUBLICATION_AUTHORITY": "HM Treasury",
        "matchKey": "10160013042",
        "score": "99",
        "type": "HM Treasury, United Kingdom List",
        "list": "Consolidated List of Financial Sanctions Targets"
      },
      {
        "name": "Ramzan Akhmatovich KADYROV",
        "birthdate": "19761005",
        "additionalInformation": "Program: RUSSIA-EO14024; GLOMAG; MAGNIT; ID: ...",
        "country": "RUS;ARE",
        "countryOfOrigin": "RUS",
        "countryOfActivity": "RUS;ARE",
        "match_rule": "R2",
        "data_pool": "aml-rep-info4c-sanction-list",
        "PUBLICATION_AUTHORITY": "United States Department of the Treasury",
        "matchKey": "10131023353",
        "score": "99",
        "type": "United States Department of the Treasury, OFAC SDN List",
        "list": "OFAC SDN (Specially Designated Nationals) List"
      }
    ],
    "listHit": false
  },
  "requestDateTime": "2023-06-02T15:59:42.000Z",
  "responseCode": "0000",
  "responseDescription": "Successful execution.",
  "additionalInformation": {
    "requestId": "b3c4174639e349a4a7cb40f42ab02f38"
  }
}

Company Compliance Check Request

Path:: POST {baseURL}/compliance/company-check
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "customerId": "100001",
    "companyName": "WEST SUN TRADE GMBH",
    "addressLine1": "Karlstrasse",
    "house": "2",
    "postCode": "76133",
    "city": "Karlsruhe",
    "countryCode": "de"
}

Company Compliance Check Response (RED)

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "complianceData": {
        "archiveId": "4040062516381252",
        "trafficLight": "RED",
        "hitType": "SL",
        "manualReview": false,
        "details": [
            {
                "name": "WEST SUN TRADE GMBH",
                "function": "Program: IRAN; Remarks ...",
                "match_rule": "R0",
                "data_pool": "aml-rep-info4c-sanction-list",
                "ADDITIONAL_INFORMATION": "Program: IRAN; Remarks...",
                "matchKey": "10131011655",
                "score": "100",
                "type": "United States Department of the Treasury, OFAC SDN List",
                "list": "IRAN"
            }
        ],
        "listHit": false
    },
    "requestDateTime": "2023-06-02T16:04:05.000Z",
    "responseCode": "0000",
    "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "b2299b33237c4df092b4ff8414bbb3ee"
    }
}

Company Compliance Check Response (GREEN)

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "complianceData": {
        "archiveId": "4434062516381435",
        "trafficLight": "GREEN",
        "manualReview": false,
        "details": [],
        "listHit": false
    },
    "requestDateTime": "2023-06-02T16:08:59.000Z",
    "responseCode": "0000",
    "responseDescription": "Successful execution.",
    "additionalInformation": {
        "requestId": "d2ebbb8a39624e0eac71ae1f470c2f3a"
    }
}

The result of the compliance check is summarized in the parameter “trafficLight” and can take on the following values:

Value	Explanation
“RED”	Hit.
“YELLOW”	Unsure hit.
“GREEN”	No hit.

We receive an unsure hit in our example response, because no perfect match, but similar entries (differing birthdates) could be found for the provided personal data.

Each found entry is stored as an array item in the parameter “details” and consists of a list of “name” -> “value” pairs.

Due to regulatory requirements, a person or company must not be part of one of the following lists (see parameter “hitType”):

Value	Explanation
“SL”	Sanctions List
“BL”	Blacklist
“PEP”	Politically Exposed Person

If the check result has been manually added to the compliance white/black list, the parameter “listHit” is set to “True.

Previous

Next