PUT
/
compliance
/
kyb
/
{name}

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

Path Parameters

name
string
required

Name of the aggregated merchant declared in the kyb.

Body

application/json
name
string
required

Name of the declared sub-merchant

businessType
string
required

Type of business of the sub-merchant

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

headquarterAddress
string
required

Address of the headquarter of the company

Response

200 - application/json
merchantId
string
required

The id identifying the merchant

name
string
required

Name of the declared sub-merchant

businessType
string
required

Type of business of the sub-merchant

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

headquarterAddress
string
required

Address of the headquarter of the company

id
number
required

The id identifying the kyb

createdAt
string
required

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

Retrieve a kyb by nameDelete a kyb