What a workflow can be built from

GET/v1/workflows/catalog

Generated from the rules the server checks: every step with its name, description, price in CHF, options (id, description, default) and dependencies (requires: all of these steps; requires_one_of: at least one of each list); the settings a workflow takes (minimum_age, ip_countries, location_countries, video_hours, four_eyes, outcome_overrides with the reason codes that can be changed, score_thresholds, status_rules fields and checks, document_rules); and the countries and documents of the key's environment. countries is null with countries_error when the document catalog is unavailable. Needs the sessions:write or workflows:write scope; same setup rights as listing.

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

Responses

  • 200The catalog.
    • environmentstring

      One ofsandboxproduction

    • currencystring

      One ofCHF

    • stepsarray of object
      Show 8 child properties
      • idstring
      • namestring
      • descriptionstring
      • price_chfnumber
      • billedstring

        One ofper_verificationper_companyincluded

      • requiresarray of string
      • requires_one_ofarray of array of string
      • optionsarray of object
        Show 4 child properties
        • idstring
        • descriptionstring
        • defaultboolean
        • price_chfnumber
    • settingsobject

      minimum_age, ip_countries, location_countries, video_hours, four_eyes, outcome_overrides (reasons), score_thresholds (fields), status_rules (fields, ops, actions), document_rules.

    • countriesarray of object | null
      Show 5 child properties
      • countrystring

        Three-letter lowercase code, as in document_rules.

      • namestring
      • documentsarray of string
      • choicesarray of string

        document_type:choice_id

      • chiparray of string

        Document types with a readable chip.

    • countries_errorstring
  • 401Missing, unknown or expired API key.
  • 403The key lacks the scope, or was issued through Connect with secuveri without the setup right.
curl https://api-verify.secuveri.com/v1/workflows/catalog \
  -H "x-api-key: $SECUVERI_API_KEY"
Response · 200
{
  "environment": "sandbox",
  "currency": "CHF",
  "steps": [
    {
      "id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
      "name": "Jane Doe",
      "description": "<description>",
      "price_chf": 1,
      "billed": "per_verification",
      "requires": [
        "string"
      ],
      "requires_one_of": [
        [
          "string"
        ]
      ],
      "options": [
        {
          "id": "0b8f4f5e-3c2a-4d1b-9e7f-6a5c4b3d2e1f",
          "description": "<description>",
          "default": true,
          "price_chf": 1
        }
      ]
    }
  ],
  "settings": {},
  "countries": [
    {
      "country": "CHE",
      "name": "Jane Doe",
      "documents": [
        "string"
      ],
      "choices": [
        "string"
      ],
      "chip": [
        "string"
      ]
    }
  ],
  "countries_error": "<countries error>"
}