Skip to main content
POST
Create a KYC link for a customer

Authorizations

Authorization
string
header
required

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

Body

application/json
external_customer_id
string
required

Your reference for the customer being verified (echoed on every webhook).

idempotency_key
string
required
country
string

KYB only. Wizard corridor (us, cl, ve, br, mx, co, pe, bo, py, ar, generic).

generic_country
string

ISO alpha-2 when country=generic.

currency
string
label
string
expires_in_days
integer
metadata
object

Response

KYC link created.

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