Skip to main content
POST
/
accounts
/
{accountId}
/
related-persons
/
{personId}
/
kyc-link
Generate KYC Link
curl --request POST \
  --url https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "KYC link generated successfully",
  "data": {
    "token": "<string>",
    "url": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "relatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
Generates a hosted identity verification link for a related person. Share the link with the person — it opens a Rolla-hosted page where they upload an ID document and complete a liveness check. Their verification status is reflected in Get Requirements.

​
Example Request

curl -X POST "https://api.rolla.xyz/api/v1/external/accounts/eec3cbed-79d8-4370-87a0-b6be9e287337/related-persons/a3d4f21e-f499-488f-8508-43228dfea485/kyc-link" \
  -H "X-API-Key: your_api_key_here"

​
Example Response

{
  "success": true,
  "message": "KYC link generated successfully",
  "data": {
    "token": "969e35c36f99f9d511863c89cea0d4082bc3bf66b5484d9a70d79a7c39d6fe74",
    "url": "https://app.rolla.xyz/en/kyc/director/969e35c36f99f9d511863c89cea0d4082bc3bf66b5484d9a70d79a7c39d6fe74",
    "status": "active",
    "expiresAt": "2026-06-15T23:32:12.902Z",
    "relatedPersonId": "a3d4f21e-f499-488f-8508-43228dfea485"
  }
}

​
Key Behaviours

Links expire after 72 hours. Generating a new link for the same person invalidates the previous one.
The link status becomes completed once the person passes verification, or rejected if it fails — in which case you can generate a fresh link for a retry.

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Path Parameters

​
accountId
string<uuid>
required

Identifier of an account owned by the same user as your API key's business

​
personId
string<uuid>
required

Related person identifier

Response

KYC link generated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"KYC link generated successfully"

​
data
object