Initialize a verification session
Initialize a session before the user verifies and get back a hosted verification link with a queued-up session. Redirect the user to the returned url; they come back to the redirect URL configured on the verification with ?vyt=<token>&vyc=<0|1>, which you confirm server-side at GET /v3/confirmations/{token}.
Accepts a publishable key (browser) or a secret key (server). email, phone, external_id, verification_id, and verification_external_id require a secret key. See each parameter below for what it does and when it’s required.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Secret key only. Target a verification directly instead of running the company's default verification.
Secret key only. Target a verification by your own external id for it (set when the verification was created), as an alternative to verification_id.
"signup-flow"
Secret key only. Attach a stable identity to the verification. Fails if that identity is already in use.
"user@example.com"
Secret key only. Attach a stable identity to the verification. Fails if that identity is already in use.
Secret key only. Link this verification to your own user or record id.
"user_123"
Non-PII label echoed back in the flow webhook payload. Use it to correlate funnel events with your own analytics.
Extra query params to carry through the flow and append to the return URL. Reserved vy* keys are ignored.
Response
Successful Response