Update a workflow | Verifa

import requests
url = "https://devapi.withverifa.com/api/v1/workflows/workflow_id"
payload = {}
headers = {
    "X-API-Key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "wfl_abc123",
  "name": "Standard KYC",
  "version": 3,
  "steps": [
    {
      "policy": "document_ocr",
      "label": "Document OCR",
      "config": {},
      "on_fail": "review",
      "on_error": "review"
    }
  ],
  "is_default": true,
  "is_active": true,
  "created_at": "2024-01-15T09:30:00Z",
  "description": "string",
  "step_count": 4,
  "updated_at": "2024-01-15T09:30:00Z",
  "data_requirements": {},
  "format": "steps",
  "graph": {}
}

Updates a workflow's configuration. Creates a new version.

Authentication

X-API-Keystring

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

Path parameters

workflow_idstringRequired

Workflow ID (wfl_*).

Request

This endpoint expects an object.

namestringOptional

descriptionstring or nullOptional

stepslist of maps from strings to anyOptional

data_requirementsmap from strings to any or nullOptional

screening_settingsmap from strings to any or nullOptional

graph_layoutmap from strings to any or nullOptional

rollout_percentageinteger or nullOptional0-100

Response

Updated workflow.

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

404

Not Found Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors