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 workflows
      • POSTCreate a workflow
      • GETGet a workflow
      • PATCHUpdate a workflow
      • POSTTrigger a workflow
      • GETGet session workflow run
      • GETList available verification policies
      • GETList workflow versions
      • GETGet workflow analytics
      • POSTSet a workflow as default
      • POSTDeactivate a workflow
      • GETList workflow drafts
      • GETGet a workflow draft
      • GETDiff a draft against the current workflow
      • POSTDry-run a workflow draft
      • POSTPublish a workflow draft
      • POSTDry-run a workflow
      • GETGet workflow rollout map
      • PUTUpdate workflow rollout map
      • POSTClone a workflow
      • GETList verification policies
API ReferenceWorkflows

Dry-run a workflow

POST
https://devapi.withverifa.com/api/v1/workflows/:workflow_id/dry-run
POST
/api/v1/workflows/:workflow_id/dry-run
$curl -X POST https://devapi.withverifa.com/api/v1/workflows/workflow_id/dry-run \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "preset": "identity_verification_basic"
>}'
1{
2  "steps": [
3    {
4      "node_id": "node_12345",
5      "node_type": "document_check",
6      "policy": "passport_validation",
7      "status": "completed",
8      "passed": true,
9      "details": {},
10      "duration_ms": 350,
11      "routed_to": "verifa_sandbox_server_1",
12      "outcome": "approved"
13    }
14  ],
15  "preset": "identity_verification_basic",
16  "preset_description": "Basic identity verification preset simulating passport document checks and facial recognition."
17}

Simulates the currently serving workflow’s graph (or a caller-supplied graph) against a sandbox preset. Use the reserved _unsaved workflow ID to dry-run an unsaved inline graph.

Required scope: workflows:read

Was this page helpful?
Previous

Get workflow rollout map

Next
Built with

Authentication

X-API-Keystring

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

Path parameters

workflow_idstringRequired

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.
presetstringRequired
Sandbox preset name that drives the simulated responses.
graphmap from strings to any or nullOptional
Optional inline graph to simulate instead of the stored one.

Response

Dry-run result.

stepslist of objects
presetstring
preset_descriptionstring

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error