Dry-run a workflow

POST

https://devapi.withverifa.com/api/v1/workflows/:workflow_id/dry-run

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

Authentication

X-API-Keystring

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

Path parameters

workflow_idstringRequired

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

$	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	}

Authentication

Path parameters

Headers

Request

Response

Errors