For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
      • GETList sessions
      • POSTCreate a verification session
      • GETGet a session
      • PATCHUpdate a session
      • POSTResume a session
      • POSTResend the invitation email
      • POSTExpire a session
      • POSTSimulate a session action (sandbox only)
      • GETGet session result
      • DELRedact session data
      • GETExport session data (GDPR Art. 15 DSAR)
      • POSTBulk redact sessions
      • POSTSubmit a session for verification
      • POSTAdd a tag to a session
      • POSTRemove a tag from a session
      • POSTReplace all tags on a session
      • POSTGenerate a one-time verification link
      • GETList one-time links for a session
      • GETList verification checks
      • POSTRetry a failed verification check
      • GETList verification attempts
      • GETGenerate PDF verification report
      • POSTSubmit external gate decision
      • POSTReprocess a session
      • GETList webhook deliveries for a session
      • GETGet session risk assessment
API ReferenceSessions

Simulate a session action (sandbox only)

POST
https://devapi.withverifa.com/api/v1/sessions/:session_id/simulate
POST
/api/v1/sessions/:session_id/simulate
$curl -X POST https://devapi.withverifa.com/api/v1/sessions/session_id/simulate \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "action": "approve"
>}'
1{
2  "id": "ses_abc123",
3  "action": "approve",
4  "status": "string",
5  "simulated": true
6}
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.
Was this page helpful?
Previous

Get session result

Next
Built with

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_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.

Request

This endpoint expects an object.
actionenumRequired
The lifecycle action to simulate.
Allowed values:

Response

Simulation applied.
idstring
actionstring
statusstring
The session's new status after simulation.
simulatedboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error