v1

latestOpenAPI 3.0.02026-07-265892227.1 KB

Compliance

Fetch a kyb list

get/compliance/kyb

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

merchantIdstring required

The id identifying the merchant

namestring required

Name of the declared sub-merchant

businessTypestring required

Type of business of the sub-merchant

businessRegistrationIdstring required

Business registration id

taxNumberstring required

Tax number

directorNamestring required

Director name

websiteUrlstring required

Website url of the company

countrystring required

Country where the company is located

headquarterAddressstring required

Address of the headquarter of the company

idnumber required

The id identifying the kyb

createdAtstring date-time required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

deletedAtobject required

Datetime in UTC timezone at which this object was deleted. Follows the Datetime ISO. Can be null.

Example response

[
  {
    "merchantId": "156",
    "name": "Example merchant",
    "businessType": "Fintech",
    "country": "CI",
    "id": 1,
    "createdAt": "2020-10-15T12:09:49.355Z"
  }
]