API ReferenceWorkflows

Create a workflow

Creates a new verification workflow with the specified steps.

Authentication

X-API-Keystring

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

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:

Request

This endpoint expects an object.
namestringRequired
stepslist of maps from strings to anyRequired
descriptionstring or nullOptional
is_defaultbooleanOptionalDefaults to false
data_requirementsmap from strings to any or nullOptional
screening_settingsmap from strings to any or nullOptional
graph_layoutmap from strings to any or nullOptional

Response

Workflow created.
idstring
namestring
versioninteger
stepslist of objects
Ordered list of workflow steps.
is_defaultboolean
is_activeboolean
created_atdatetime
descriptionstring or null
step_countinteger
Number of steps in the workflow.
updated_atdatetime
data_requirementsmap from strings to any or null
Data requirements configuration for this workflow.
formatenumDefaults to steps

Workflow format — “steps” for legacy array format, “graph” for DAG format.

Allowed values:
graphmap from strings to any or null

DAG graph representation of the workflow. Present when format is “graph”. Contains “nodes” (dict of node objects) and “entry” (start node ID).

Errors

401
Unauthorized Error
422
Unprocessable Entity Error