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
purposeenumOptional

Declares what the workflow is used for. Downstream checks like consortium matching use this to score cross-org matches contextually. For example, the same face at two schools is normal for enrollment but suspicious for financial aid.

compliance_levelenumOptional

Compliance standard to enforce on this workflow. When set to “ial2”, the workflow must include document_ocr, face_match, proof of address, OTP verification, and user info with name fields per NIST SP 800-63-3.

Allowed values:

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. Keys: selfie (bool), document ({enabled, accepted_types} — set enabled to false for document-free selfie-only workflows; requires selfie true), user_info ({enabled, fields, required_fields, verify_phone, verify_email}), proof_of_address ({enabled, accepted_types}).

formatenumDefaults to steps

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

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

purposeenum

What the workflow is used for. Used by consortium matching to apply purpose-aware scoring — e.g., financial aid matches are scored higher than enrollment matches.

compliance_levelenum

Compliance standard enforced on this workflow. “ial2” enforces NIST SP 800-63-3 identity proofing requirements.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error