Company Compliance Check

POST /compliance/company-check

This endpoint performs a company compliance check.

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.

Request

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

application/json

Body
Example

Bodyrequired

customerIdstring

Optional customer ID. The customerId is an optional request parameter, and can be acquired by contacting Product Solution Specialist / Key Account Manager.

companyNamestringrequired

Name of the company.

addressLine1stringrequired

First line of the address.

Possible values: <= 127 characters

housestringrequired

House number.

Possible values: <= 10 characters

postCodestringrequired

Postal code.

Possible values: <= 10 characters

citystringrequired

City of the company's address.

Possible values: <= 64 characters

countryCodestringrequired

Country code (ISO 3166-1 alpha-2 format).

Possible values: <= 2 characters

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

Responses

Successful response with compliance data.

application/json

Schema
Example (auto)
Red Response
Green Response

Schema

complianceData object

archiveIdstring

ID of the compliance check archive

trafficLightstring

Result of the compliance check:

GREEN: No hit.
YELLOW: Unsure hit.
RED: Hit.

Possible values: [GREEN, YELLOW, RED]

hitTypestring

Type of hit:

SL: Sanctions List
BL: Blacklist
PEP: Politically Exposed Person
Due to regulatory requirements, a person or company must not be part of this list.

Possible values: [SL, BL, PEP]

manualReviewboolean

Indicates if manual review is required

details object[]

Details of any matches found

Array [

namestring

Name of the matched company

functionstring

Function or program related to the match

countryOfActivitystring

Country of activity of the matched individual

match_rulestring

Match rule applied

data_poolstring

Data pool from which the match was found

ADDITIONAL_INFORMATIONstring

Additional information about the match

matchKeystring

Key for the match

scorestring

Score of the match

typestring

Type of the match

liststring

List from which the match was found

]

listHitboolean

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

requestDateTimestring<date-time>

Date and time of the request

responseCodestring

Response code of the compliance check

responseDescriptionstring

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.

requestIdstring

ID of the request

{
  "complianceData": {
    "archiveId": "string",
    "trafficLight": "GREEN",
    "hitType": "SL",
    "manualReview": true,
    "details": [
      {
        "name": "string",
        "function": "string",
        "countryOfActivity": "string",
        "match_rule": "string",
        "data_pool": "string",
        "ADDITIONAL_INFORMATION": "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"
  }
}

Red response example

{
  "complianceData": {
    "archiveId": "4040062516381252",
    "trafficLight": "RED",
    "hitType": "SL",
    "manualReview": false,
    "details": [
      {
        "name": "WEST SUN TRADE GMBH",
        "function": "Program: IRAN; Remarks ...",
        "countryOfActivity": "IRN",
        "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"
  }
}

Green response example

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

Bad Request

info

For error handling, please refer to this section.

application/json

Schema
Example (auto)
Example

Schema

errorstring

errorDetails object

contextobject

gatewayDescriptionstring

paymentProviderDescriptionstring

message object

oneOf

string
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

info

For error handling, please refer to this section.

application/json

Schema
Example (auto)
Example

Schema

errorstring

errorDetails object

contextobject

gatewayDescriptionstring

paymentProviderDescriptionstring

message object

oneOf

string
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

info

For error handling, please refer to this section.

application/json

Schema
Example (auto)
Example

Schema

errorstring

errorDetails object

contextobject

gatewayDescriptionstring

paymentProviderDescriptionstring

message object

oneOf

string
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

info

For error handling, please refer to this section.

application/json

Schema
Example (auto)
Example

Schema

errorstring

errorDetails object

contextobject

gatewayDescriptionstring

paymentProviderDescriptionstring

message object

oneOf

string
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

info

For error handling, please refer to this section.

application/json

Schema
Example (auto)
Example

Schema

errorstring

errorDetails object

contextobject

gatewayDescriptionstring

paymentProviderDescriptionstring

message object

oneOf

string
string[]

string

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Company Compliance Check

/compliance/company-check

Request​

Header Parameters

Bodyrequired

Responses​

Request

Responses