Skip to main content
GET
Get a KYC link

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Path Parameters

Response

The link with its live state.

kind
enum<string>
Available options:
kyc,
kyb
external_customer_id
string
url
string

Hosted wizard URL to share with the verified person/business.

status
enum<string>
Available options:
pending,
opened,
completed,
expired
country
string
label
string
expires_at
integer
submission_id
string

Present once the link is completed.

verification_fee
string
idempotency_key
string
created_at
string<date-time>
updated_at
string<date-time>
Last modified on July 18, 2026