Read one workflow

GET/v1/workflows/{id}

The full definition of a workflow of the key's environment, drafts included, with price_per_verification_chf. live is true when it is published and active, so new verifications run it. Needs the sessions:write or workflows:write scope. A key issued through Connect with secuveri sees drafts only with the workflows:write setup right.

Send your API key in the x-api-key header.

Path parameters

  • idstringuuidrequired

Responses

  • 200The workflow.
    • workflowobject
      Show 21 child properties
      • idstringuuid
      • namestring
      • descriptionstring
      • environmentstring

        One ofsandboxproduction

      • statusstring

        One ofdraftpublished

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

    • liveboolean
  • 401Missing, unknown or expired API key.
  • 403The key lacks the scope, or was issued through Connect with secuveri without the setup right.
  • 404No workflow with this id in the key's organization and environment.
curl https://api-verify.secuveri.com/v1/workflows/6f1c2e0a-8f43-4f7e-9a51-2b7c1d9e4a10 \
  -H "x-api-key: $SECUVERI_API_KEY"
Response · 200
{
  "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
  },
  "live": true
}