Skip to main content
GET
curl
Alerts, activity entries and webhooks fire only when a screening result moves, so this history is the record that a clean subject was still being screened. Continuous AML monitoring explains how re-screens run and what each field means. To hand the same history to an auditor as a file, use Export AML screening history.

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

node_id
string

Workflow graph node ID of the AML check. Needed only when the session ran more than one AML step; without it the most recent AML check is used. An unknown node returns 404.

Example:

"feature_aml_1"

limit
integer
default:50

Maximum number of screening runs 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 -completed_at. Pass a result field name (for example completed_at, started_at, outcome or score) to sort ascending, prefix it with - to sort descending, and separate several fields with commas. Unknown fields are ignored.

Example:

"completed_at"

Response

One page of screening runs, newest first.

count
integer
required

Number of runs, exact up to 100 and capped at 100 above that.

Required range: x <= 100
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