API ReferenceSessions

Update a session

Updates metadata on an existing session. Only external_ref and metadata can be changed. Sessions that have been redacted cannot be updated.

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.

Request

This endpoint expects an object.
external_refstringOptional<=255 characters
Update the external reference for this session.
metadatamap from strings to anyOptional

Merge keys into the session’s metadata. Existing keys not included in the request are preserved. Set a key to null to remove it. Each value is capped at 16 KB of serialized UTF-8.

Response

Updated session.
idstring
statusenum
is_sandboxboolean
environmentstring
Environment ID for this session.
created_atdatetime
updated_atdatetime
external_refstring or nullOptional
metadatamap from strings to anyOptional
countrystring or nullOptional
checkslist of strings or nullOptional
workflow_idstring or nullOptional
Workflow used for this session.
document_typestring or nullOptional
Detected or specified document type.
retention_statusstring or nullOptional

Data retention status (active, sensitive_redacted, redacted).

processing_attemptsinteger or nullOptional
Number of processing attempts for this session.
consent_ipstring or nullOptional
IP address from which consent was given.
capture_urlstring or nullOptional

Capture URL (only present while session is pending/capturing).

token_expires_atdatetime or nullOptional
When the capture token expires.
case_idstring or nullOptional
Associated review case ID, if any.
case_statusstring or nullOptional
Status of the associated review case.
tagslist of stringsOptional

Free-form tags attached to this session.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error