POST
/
api
/
onboardings
/
{country}
/
incremental
/
link
curl --request POST \
  --url https://app.sandbox.rio.trade/api/onboardings/{country}/incremental/link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "userId": "70d5ec9af663fbd39a1fa523"
}'
{
  "id": "666200897ccde94e02b8f286",
  "kycLink": "https://bridge.withpersona.com/verifyinquiry-template-id=itmpl_NtHYpb9AbEYCPxGo5iRbc9d2&fields[iqt_token]=46f7565fe2ba42843b957cec6d783e48f85dff6d6ea56cf5753634b09a3214e8&fields[developer_id]=9d540ad5-c860-4b0a-9cfa-b6ed4970cb92&reference-id=1952ee0b-ee7c-4308-b9fe-ffb1b0067c9e",
  "tosLink": "https://dashboard.bridge.xyz/accept-terms-of-servicecustomer_id=1952ee0b-ee7c-4308-b9fe-ffb1b0067c9e"
}

​
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 the existing user will operate.

Available options:
MX,
PE,
US

Body

application/json
​
userId
string
required

Response

200
application/json
OK
​
id
string

Id of the onboarding.

​
kycLink
string

KYC link for the onboarding.

​
tosLink
string

Terms of Service link for the onboarding.

Create onboarding by linkExport orders as csv