Skip to main content
POST
Creates a new identity verification link that can be sent to a customer to complete their KYC process. The link connects to the configured identity provider (e.g., Sumsub) and, upon successful completion, triggers the on-chain identity verification.

Request Body

The request body is passed directly to the ID link service. Required fields depend on the identity provider configuration for your instance.
string
Customer email address. Used to send the verification link.
string
Ethereum wallet address to associate with the verification.
string
ISO country code for the customer.
string[]
Delivery channels for the link (e.g., ["email"], ["sms"], ["email", "sms"]).
object
Arbitrary metadata to attach to the link.

Response Fields

boolean
Request status
object
The created ID link object, including the generated link URL and its current status.