Upload a document to a session
Upload a document image (ID front, ID back, or selfie) to a session via the API. This enables document submission from native mobile apps or custom UIs without using the hosted capture flow.
If a document of the same type already exists, it is replaced (idempotent).
If the session was in pending status, it transitions to capturing.
Required scope: documents:write
Authentication
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
Path parameters
Session ID (ses_*).
Headers
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.
Request
The document image file (JPEG, PNG, WebP, or PDF). Max 10MB.
Proof-of-address document subtype. Optional, but strongly
recommended when document_type is proof_of_address:
without it the check cannot apply the per-type recency
window and falls back to the policy default.
Date printed on the proof-of-address document (YYYY-MM-DD).
Compared against the date OCR reads off the document — a
disagreement larger than the policy’s
date_match_tolerance_days raises a date_mismatch reason.
Country that issued the proof-of-address document. Optional; defaults to the country of the ID document on the session. Drives country-aware address normalisation, PO-box detection, and any per-country recency override in the policy.