Create a verification session
Creates a new verification session and returns a capture_url that you
redirect (or embed) for the end user to complete identity verification.
Required scope: sessions:create or sessions:write
Creates a new verification session and returns a capture_url that you
redirect (or embed) for the end user to complete identity verification.
Required scope: sessions:create or sessions:write
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
Unique key for idempotent requests. Cached for 24 hours. Sending the
same key with different parameters returns 422.
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.
Response key casing. Defaults to snake.
Arbitrary key-value metadata attached to the session. Up to 50
keys; each individual value is capped at 16 KB of UTF-8 when
serialized. Requests exceeding either bound return 422.
ISO 3166-1 alpha-2 country code for document expectations.
Per-session check overrides. If omitted, the workflow’s default checks are used.
Send an email invitation to the applicant with a link to complete
verification. Requires applicant_email to be set (either at the
top level or under metadata.applicant_email).
Email address to send the verification invitation to. Only used
when send_email is true. Falls back to metadata.applicant_email
if not provided at the top level.
Display name for the applicant. Used to personalize the opener
of the invitation email (“Jane Doe, please click…”). Only used
when send_email is true.
Override the brand name shown in the invitation email’s subject
line and body for this session only. Defaults to your organization’s
configured email display name, or your organization name. Useful
when sending under a sub-brand. Only used when send_email is true.
Override the support link shown in the invitation email’s recovery
sentence (“contact support to have a new link sent”) for this
session only. Defaults to your organization’s configured
verification support URL. Must be an http or https URL.
Only used when send_email is true.
Session expiration in minutes. Determines how long the capture URL remains valid. Minimum 10 minutes, maximum 4320 (72 hours). Defaults to 1440 (24 hours) if not specified.
Optional pre-fill values written into session capture data on create. Values are stored encrypted at rest. Pre-filling does not auto-complete capture steps — the user still walks through the capture flow. Each field accepts both the canonical snake_case name and the kebab-case alias shown in parentheses.
Base64-encoded QR code PNG pointing to the capture URL.