Get a published workflow

GET

/api/kyc/workflows/:workflowId

GET

/api/kyc/workflows/:workflowId

curl https://sandbox-api.toden.co/api/kyc/workflows/workflowId \
     -H "Authorization: Bearer <apiKey>"

{
  "workflow": {
    "id": "wf_AbC123dEf456",
    "name": "Identity verification",
    "version": 3
  },
  "config": {
    "country": "NG",
    "enableLiveness": true,
    "idTypes": [
      "bvn"
    ]
  },
  "environment": "SANDBOX",
  "idTypes": [
    {
      "country": "NG",
      "idType": "bvn",
      "supportsNfc": false,
      "label": "Bank Verification Number (BVN)",
      "requiresDocumentCapture": false,
      "scanSides": "front_only",
      "features": {
        "documentVerification": true,
        "livenessCheck": true,
        "govDbCheck": true
      }
    }
  ],
  "branding": {
    "trustAttribution": {
      "mode": "myaza"
    },
    "companyName": "Example Ltd"
  },
  "geoCountry": "NG",
  "addressSearch": false,
  "deviceAttestation": {
    "playIntegrityCloudProjectNumber": null
  }
}

Returns a published workflow with the same ID types, branding and address settings as the configuration endpoint, so one request prepares an SDK mounted with a workflow. idTypes is empty for a workflow that has no ID step.

A draft, archived or suspended workflow, and one belonging to another organisation or environment, all answer with the same 404.

Error codes

`error`	Status	Meaning
`workflow_not_found`	404	No published workflow with that id for this organisation and environment.
`Missing or invalid Authorization header`	401	No bearer credential was sent.
`Invalid API key`	401	The key is unknown or revoked.
`environment_mismatch`	403	The key belongs to an environment this host does not serve.
`origin_not_allowed`	403	The request origin is not on the publishable key allowlist.
`ip_not_allowed`	403	The caller address is not on the secret key allowlist.
`organization_suspended`	403	The organisation is suspended.

Accepts a publishable (pk_) or secret (sk_) key.

Authentication

AuthorizationBearer

Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Path parameters

workflowIdstringRequired

The workflow public identifier, for example wf_AbC123dEf456.

Response

The workflow.

workflowobject

The workflow.

configmap from strings to any

The published workflow configuration: steps, countries, ID types and appearance.

environmentenum

The environment of the API key.

Allowed values:

idTypeslist of objects

The ID types enabled for your organisation. Disabled ones are omitted.

brandingobject

Your organisation branding, as the SDK shows it.

geoCountrystring or null

A best guess at the caller country from their network address, as an ISO 3166 alpha-2 code. A default for forms, never evidence.

addressSearchboolean

Whether address search is available for the address step.

deviceAttestationobject

What a mobile SDK needs to attest the app it runs in.

addressSearchModeenumOptional

How address search behaves. Absent when address search is unavailable.

Allowed values:

mapsFrameUrlstringOptional

The address of the hosted map picker for this caller. Absent when no map picker is available.

applicantWorkflowobjectOptional

For a business workflow, the workflow the applicant own identity check runs through. Absent when none is mapped.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error