POST
/
api
/
onboardings
/
{country}
/
link
curl --request POST \
  --url https://app.sandbox.rio.trade/api/onboardings/{country}/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "userType": "business",
  "brokerId": "60d5ec9af682fbd39a1fa614",
  "referrerId": "70d5ec9af663fbd39a1fa523"
}'
{
  "id": "6662001b7ccde94e02b8f277",
  "kycLink": "https://verify-sandbox.aiprise.com/verification_session_id=f12338a5-2415-4e0f-bdd9-2cea41717c82"
}

​
Requirements to consume the endpoint.

Create and modify role

The user must have the role to create and modify.

Authorizations

​
x-api-key
string
header
required

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
OK
​
id
string

Id of the onboarding response.

​
kycLink
string

KYC link for the onboarding.

Get bulk crypto paymentCreate incremental onboarding by link