Skip to main content
GET
/
api
/
users
/
{id}
/
link
Get user onboarding links
curl --request GET \
  --url https://app.sandbox.rio.trade/api/users/{id}/link \
  --header 'x-api-key: <api-key>'
{
  "onboardingLink": "https://verification.aiprise.com/session/abc123",
  "termsLink": "https://bridge.com/terms/xyz789"
}
Retrieves onboarding verification links for a user. For non-US users, returns verification links. For US users, returns KYC and terms links.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

ID of the user to get onboarding links for.

Response

OK

​
onboardingLink
string
required

URL for the user's onboarding verification session.

Example:

"https://verification.aiprise.com/session/abc123"

​
termsLink
string

URL for the terms and conditions (only for US users).

Example:

"https://bridge.com/terms/xyz789"