Skip to main content
POST
Generate KYC link

Authorizations

API-KEY
string
header
required

Your partner API key. The key must carry the customers permission.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer reference id returned by create — a cus_-prefixed string, not a UUID.

Response

A hosted verification link.

url
string

The hosted verification link to send the customer.

userId
string

The customer reference id — cus_….

ttlSeconds
integer

How long the link stays valid, in seconds.

expiresAt
string<date-time>

When the link expires. Fractional seconds vary in length.