Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

settings_uuid
string<uuid>
required

Per-version UUID of the workflow (the uuid value returned by the list endpoint). Each version of a workflow has its own settings_uuid.

Response

Full workflow configuration. The shape is the raw VerificationSettings serialization (~190 fields: every feature toggle, threshold, warning action, allowed-documents config, the workflow_graph, retry policy, callbacks and pricing). The example below is abbreviated. Notes: features is a " + "-joined string (e.g. "OCR + LIVENESS"), prices are JSON numbers, and is_editable is true only for draft versions.