Skip to main content
PATCH
curl
The field keys are the ones you configured for the document in the workflow. See Document AI for how documents and fields are set up, and the Document AI report for where the result appears in the session decision.

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"

documentUuid
string<uuid>
required

UUID of the Document AI document (document_ai_documents[].items[].uuid in GET /v3/session/{sessionId}/decision/). It must belong to the session in the path.

Example:

"44444444-5555-6666-7777-888888888888"

Body

application/json
extracted_data
object

Field keys (the keys you configured for the document) and their corrected values. Must be a JSON object; merged key by key into the stored data. Leave it out rather than sending null, which returns 400.

Example:
status
enum<string>

New review status of the document.

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

"Approved"

Response

Document updated. Returns the document after the merge.

uuid
string<uuid>
required

Document identifier.

document_key
string
required

The configured document this upload corresponds to.

original_filename
string | null
required

File name the document was uploaded with.

file_url
string | null
required

Storage path of the uploaded file. It is not a download link: read the presigned file_url from the session decision to download the file.

status
enum<string>
required

Review status of the document.

Available options:
Not Finished,
Approved,
Declined,
In Review,
Resub Requested
extracted_data
object | null
required

All extracted fields after the merge, keyed by field key.