Create a draft workflow
/v1/workflowsCreates a draft in the key's environment, checked like a save in the dashboard: known steps and options, step dependencies, minimum age, outcome overrides, score thresholds, status rules and document rules. Read GET /v1/workflows/catalog first for what can be built. A draft does not run verifications until it is published (POST /v1/workflows/{id}/publish). The response has the workflow with price_per_verification_chf and warnings: hints on a valid definition that is probably not what was meant (for example an age estimate without an ID fallback). Needs the workflows:write scope (a key issued through Connect with secuveri: the workflows:write setup right). At most 30 changes per minute per organization.
Send your API key in the x-api-key header.
Request bodyapplication/jsonrequired
- namestring≤ 120 charsrequired
- descriptionstring≤ 2000 chars
- environmentstring
Optional; must be the key's environment.
One of
sandboxproduction - minimum_ageinteger | null0–120
Needs identity-document.
- ip_countriesobject | null
Show 2 child propertiesHide child properties
- modestring
One of
allowblock - countriesarray of string
- location_countriesobject | null
Location check: the countries the device's location must (allow) or must not (block) be in. Needs location-check.
Show 2 child propertiesHide child properties
- modestring
One of
allowblock - countriesarray of string
- video_hoursobject | null
Video identification office hours; null: calls at any time. Needs video-identification.
Show 3 child propertiesHide child properties
- time_zonestring
IANA time zone, such as Europe/Zurich.
- daysobject
mon to sun: up to three non-overlapping {from, to} times as HH:MM.
- closed_datesarray of string0–100 items
- four_eyesboolean
- outcome_overridesobject
- score_thresholdsobject
- status_rulesarray of object
- stepsarray of stringrequired
Step ids from the catalog, in the order the person sees them.
- step_configsobject
Step id to {option id: boolean}, only for options that differ from their default.
- document_rulesarray of object
Responses
201The draft.
- 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: message lists every problem, errors has them one by one.
- 401Missing, unknown or expired API key.
- 403The key lacks workflows:write, names another environment than its own, or was issued through Connect with secuveri without the workflows:write setup right.
- 429More than 30 workflow changes in a minute.
curl -X POST https://api-verify.secuveri.com/v1/workflows \
-H "x-api-key: $SECUVERI_API_KEY" \
-H "content-type: application/json" \
-d '{
"name": "Jane Doe",
"steps": [
"string"
]
}'{
"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
}