POST
/
api
/
onboardings
/
{country}
/
link

​
Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

Authorizations

x-api-key
string
headerrequired

Path Parameters

country
enum<string>
required

Country in which this new user will operate.

Available options:
MX,
PE,
US

Body

application/json
userType
enum<string>
required

Type of user for whom you want to initiate the onboarding process.

Available options:
business,
individual
brokerId
string

Broker id in case this user belongs to a specific broker.

referrerId
string

Id of the user who referred this new user.

Response

200 - application/json
id
string

Id of the onboarding response.

kycLink
string

KYC link for the onboarding.

Check crypto paymentCreate incremental onboarding by link