Change a workflow
/v1/workflows/{id}Changes the fields sent; the others stay. A draft stays a draft. A published workflow stays published and the change applies to new verifications at once, as a save in the dashboard does (live: true in the response); verifications already started keep the definition they started with. The same checks as at publish apply to a published workflow's documents, and turning on the FINMA profile needs the plan that includes it. active: false takes a workflow out of use (sessions with it are refused) and can be undone; reactivating a production workflow takes a slot of the plan. The environment cannot change: copy the workflow in the dashboard instead. There is no DELETE. Needs the workflows:write scope.
Send your API key in the x-api-key header.
Path parameters
- idstringuuidrequired
Request bodyapplication/jsonrequired
- namestring
- descriptionstring
- minimum_ageinteger | null
- ip_countriesobject | null
- location_countriesobject | null
- video_hoursobject | null
- four_eyesboolean
- outcome_overridesobject
- score_thresholdsobject
- status_rulesarray of object
- stepsarray of string
- step_configsobject
- document_rulesarray of object
- activeboolean
false takes the workflow out of use; it can be turned on again.
Responses
200The workflow after the change; live says whether new verifications run it.
- workflowobject
Show 21 child propertiesHide child properties
- idstringuuid
- namestring
- descriptionstring
- environmentstring
One of
sandboxproduction - statusstring
One of
draftpublished - activeboolean
- minimum_ageinteger | null
- ip_countriesobject | null
- location_countriesobject | null
- video_hoursobject | null
- four_eyesboolean
- outcome_overridesobject
- score_thresholdsobject
- status_rulesarray of object
- stepsarray of string
- step_configsobject
Every option of the workflow's steps, defaults filled in.
- document_rulesarray of object
- created_atstringdate-time
- updated_atstringdate-time
- published_atstring | nulldate-time
- price_per_verification_chfnumber
What one verification of this workflow costs; business verification is charged per company on top.
- warningsarray of string
- liveboolean
true when the workflow is published and active: new verifications run it as it is now.
- 400Invalid definition or unknown field; errors lists the problems.
- 401Missing, unknown or expired API key.
- 402Reactivating would exceed the plan's active production workflows, or the FINMA profile is not in the plan (code plan_required).
- 403The key lacks workflows:write, the body names another environment, or the key was issued through Connect with secuveri without the workflows:write setup right.
- 404No workflow with this id in the key's organization and environment.
- 429More than 30 workflow changes in a minute.
curl -X PATCH https://api-verify.secuveri.com/v1/workflows/6f1c2e0a-8f43-4f7e-9a51-2b7c1d9e4a10 \
-H "x-api-key: $SECUVERI_API_KEY" \
-H "content-type: application/json" \
-d '{
"name": "Jane Doe",
"description": "<description>",
"minimum_age": 1
}'{
"workflow": {
"id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
"name": "Jane Doe",
"description": "<description>",
"environment": "sandbox",
"status": "draft",
"active": true,
"minimum_age": 1,
"ip_countries": null,
"location_countries": null,
"video_hours": null,
"four_eyes": true,
"outcome_overrides": {},
"score_thresholds": {},
"status_rules": [
{}
],
"steps": [
"string"
],
"step_configs": {},
"document_rules": [
{}
],
"created_at": "2026-10-23T09:12:44.120Z",
"updated_at": "2026-10-23T09:12:44.120Z",
"published_at": "2026-10-23T09:12:44.120Z",
"price_per_verification_chf": 1
},
"warnings": [
"string"
],
"live": true
}