Skip to main content
POST
Create a new customer

Authorizations

X-API-Key
string
header
required
X-API-Secret
string
header
required

Body

application/json
name
string
required

Customer name

Example:

"John Doe"

email
string
required

Customer email

Example:

"john.doe@example.com"

type
enum<string>

Customer type

Available options:
DEPOSITOR,
PAYEE
Example:

"DEPOSITOR"

isIndividual
boolean

Is individual

Example:

true

sumsubShareToken
string

Optional. Note: If you need sumsub link, please do not provide this token. If you provide this token, we will get KYC data through sumsub api with it, and you don't need sumsub link to go through KYC.

Example:

"_act-sbx-jwt-xxxx"

externalId
string

External customer identifier from partner system

Example:

"partner-customer-001"

Response

Create customer successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data