API ReferenceSessions

Resume a session

Generates a fresh capture URL for an expired or abandoned session. The session status is reset to pending and a new expiry is set.

This is useful when a user’s original link has expired and you want to re-send them a verification link without creating a duplicate session.

Sessions that are completed or have been redacted cannot be resumed.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

session_idstringRequired

Session ID (ses_*).

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:
Idempotency-KeystringOptional<=255 characters

Unique key for idempotent requests. Cached for 24 hours. Sending the same key with different parameters returns 422.

Response

Session resumed with a fresh capture URL.
idstring
statusstring
capture_urlstringformat: "uri"
Fresh capture URL for the user.
expires_atdatetime
New expiration time for the session.
qr_code_data_urlstring or null

Base64-encoded QR code image pointing to the capture URL.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error