Skip to main content
PATCH
curl
To decide on individual matches instead of the whole check, use Update AML hit status. For how screening results and statuses are produced, see AML screening.

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 to update. Needed only when the session ran more than one AML step. Takes precedence over node_id in the body.

Example:

"feature_aml_1"

Body

application/json
status
enum<string>
required

New status of the AML check.

Available options:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
Example:

"Approved"

node_id
string

Workflow graph node ID of the AML check, as an alternative to the query parameter.

Example:

"feature_aml_1"

Response

AML check status set (or unchanged when it already had this value).

message
string
required

Always AML status updated successfully.

status
enum<string>
required

Status of the AML check now.

Available options:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
previous_status
enum<string>
required

Status before the call. Equal to status when nothing changed.

Available options:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested