Skip to main content

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

Body

required

    customerId string

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

    companyName stringrequired

    Name of the company.

    addressLine1 stringrequired

    Possible values: <= 127 characters

    First line of the address.

    house stringrequired

    Possible values: <= 10 characters

    House number.

    postCode stringrequired

    Possible values: <= 10 characters

    Postal code.

    city stringrequired

    Possible values: <= 64 characters

    City of the company's address.

    countryCode stringrequired

    Possible values: <= 2 characters

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

Responses

Successful response with compliance data.

Schema

    complianceData

    object

    archiveId string

    ID of the compliance check archive

    trafficLight string

    Possible values: [GREEN, YELLOW, RED]

    Result of the compliance check:

    • GREEN: No hit.
    • YELLOW: Unsure hit.
    • RED: Hit.
    hitType string

    Possible values: [SL, BL, PEP]

    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.
    manualReview boolean

    Indicates if manual review is required

    details

    object[]

    Details of any matches found

  • Array [

  • name string

    Name of the matched company

    function string

    Function or program related to the match

    countryOfActivity string

    Country of activity of the matched individual

    match_rule string

    Match rule applied

    data_pool string

    Data pool from which the match was found

    ADDITIONAL_INFORMATION string

    Additional information about the match

    matchKey string

    Key for the match

    score string

    Score of the match

    type string

    Type of the match

    list string

    List from which the match was found

  • ]

  • listHit boolean

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

    requestDateTime date-time

    Date and time of the request

    responseCode string

    Response code of the compliance check

    responseDescription string

    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.

    requestId string

    ID of the request

Loading...