Simulate a session action (sandbox only)
Simulates a lifecycle action on a sandbox session. Creates verification
results and fires webhooks exactly as the real flow would, so you can
test your integration end-to-end without real documents.
**Sandbox API keys only.** Returns 403 if called with a live key.
Supported actions:
- `approve` — Marks the session completed with an approved result.
- `decline` — Marks the session completed with a rejected result.
- `require-review` — Flags the session for manual review.
- `expire` — Expires the session.
Authentication
X-API-Keystring
Organization API key. Keys are prefixed with vk_live_ (production) or
vk_sandbox_ (sandbox).
Path parameters
session_id
Session ID (ses_*).
Headers
Verifa-Version
API version date string (e.g. 2026-02-01). If omitted, the version
pinned to your API key is used.
Request
This endpoint expects an object.
action
The lifecycle action to simulate.
Allowed values:
Response
Simulation applied.
id
action
status
The session's new status after simulation.
simulated
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error