Skip to main content
GET
curl
The workflow routing events (WORKFLOW_BRANCH_EVALUATED, WORKFLOW_STATUS_NODE_REACHED) and their details are described in Retrieve session, which can also return the timeline of a User Verification (KYC) session inside its decision with ?include=events.

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

sessionId
string<uuid>
required

UUID of the verification session (the session_id returned by POST /v3/session/). Accepts both User Verification (KYC) and Business Verification (KYB) session IDs: the server resolves the ID across both session types. Must be a well-formed UUID; a malformed value does not match the route and returns an HTML 404.

Example:

"11111111-2222-3333-4444-555555555555"

Query Parameters

limit
integer
default:50

Maximum number of events per page. Defaults to 50. A value below 1 or a non-numeric value falls back to 50; a value above 1,000,000 returns 400.

Required range: 1 <= x <= 1000000
Example:

50

offset
integer
default:0

Number of results to skip before the first returned one. Defaults to 0; a negative or non-numeric value falls back to 0, a value above 1,000,000 returns 400. Prefer following the next and previous URLs.

Required range: 0 <= x <= 1000000
Example:

0

ordering
string

Optional sort override. The default order is -sent_at. Pass a result field name (for example sent_at, created_at, event_type, feature_step or step) to sort ascending, prefix it with - to sort descending, and separate several fields with commas. Unknown fields are ignored.

Example:

"sent_at"

Response

One page of the session's events, newest first.

count
integer
required

Total number of events of the session.

next
string<uri> | null
required

URL of the next page, or null on the last page.

previous
string<uri> | null
required

URL of the previous page, or null on the first page.

results
object[]
required