POST
/
compliance
/
kyb
{
  "merchantId": "156",
  "name": "Example merchant",
  "businessType": "Fintech",
  "businessRegistrationId": "<string>",
  "taxNumber": "<string>",
  "directorName": "<string>",
  "websiteUrl": "<string>",
  "country": "CI",
  "headquarterAddress": "<string>",
  "id": 1,
  "createdAt": "2020-10-15T12:09:49.355Z",
  "deletedAt": null
}

Headers

​
ApiKey
string
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.

​
MerchantId
string
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
enum<string>
required

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

Available options:
live,
sandbox

Body

application/json
​
merchantId
string
required

The id identifying the merchant

Example:

"156"

​
name
string
required

Name of the declared sub-merchant

Example:

"Example merchant"

​
businessType
string
required

Type of business of the sub-merchant

Example:

"Fintech"

​
businessRegistrationId
string
required

Business registration id

​
taxNumber
string
required

Tax number

​
directorName
string
required

Director name

​
websiteUrl
string
required

Website url of the company

​
country
string
required

Country where the company is located

Example:

"CI"

​
headquarterAddress
string
required

Address of the headquarter of the company

Response

200
application/json
​
merchantId
string
required

The id identifying the merchant

Example:

"156"

​
name
string
required

Name of the declared sub-merchant

Example:

"Example merchant"

​
businessType
string
required

Type of business of the sub-merchant

Example:

"Fintech"

​
businessRegistrationId
string
required

Business registration id

​
taxNumber
string
required

Tax number

​
directorName
string
required

Director name

​
websiteUrl
string
required

Website url of the company

​
country
string
required

Country where the company is located

Example:

"CI"

​
headquarterAddress
string
required

Address of the headquarter of the company

​
id
number
required

The id identifying the kyb

Example:

1

​
createdAt
string
required

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

Example:

"2020-10-15T12:09:49.355Z"

​
deletedAt
object
required

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

Example:

null