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>'

import requests

url = "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link"

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "KYC link generated successfully",
  "data": {
    "token": "<string>",
    "url": "<string>",
    "status": "active",
    "expiresAt": "2023-11-07T05:31:56Z",
    "relatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

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>'

import requests

url = "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link"

headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rolla.xyz/api/v1/external/accounts/{accountId}/related-persons/{personId}/kyc-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "KYC link generated successfully",
  "data": {
    "token": "<string>",
    "url": "<string>",
    "status": "active",
    "expiresAt": "2023-11-07T05:31:56Z",
    "relatedPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "success": false,
  "message": "<string>"
}

{
  "success": false,
  "message": "<string>"
}

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.

Already verify these people in your own onboarding? Submit Representative KYC Reliance lets you upload the passport and liveness capture you collected instead of sending them through this hosted flow. It is enabled per partner, and can be mixed with hosted links across the same account.

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

Show child attributes

Overview

Banks

Account Lookup

Transactions

Wallet

Beneficiaries

Teams

Account Onboarding

Webhooks

Generate KYC Link

Example Request

Example Response

Key Behaviours

Authorizations

Path Parameters

Response

​Example Request

​Example Response

​Key Behaviours

Authorizations

Path Parameters

Response

Example Request

Example Response

Key Behaviours