> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API per actualitzar dades de Document AI
> Corregeix els camps que Didit ha extret d'un document de Document AI, o n'estableix l'estat de revisió, en una sessió de verificació KYC o KYB.
Prompt de l'API per actualitzar les dades de Document AI
Copia el prompt al porta-retalls
\
\`Correct the extracted data of a Document AI document, or set its review status, on a Didit verification session through the API.
Endpoint:
PATCH https://verification.didit.me/v3/document-ai/{session_id}/documents/{document_uuid}/
Authentication:
Send my Didit API key in the x-api-key header. A scoped key needs decisions: write.
Goal:
\- Fix a value Document AI misread, or approve or decline a document the workflow sent to review.
Request body (JSON, both fields optional):
\- extracted_data: a JSON object of field keys to new values. Merged key by key: sent keys replace the stored values (a null value clears one), keys I leave out keep their values. Do not send extracted_data itself as null (400); leave it out instead.
\- status: "Approved", "Declined", "In Review" or "Not Finished".
Behavior:
\- Works for user (KYC) and business (KYB) session IDs.
\- {document_uuid} is document_ai_documents[].items[].uuid from GET /v3/session/{session_id}/decision/, and the document must belong to that session.
\- The document status feeds the Document AI result of its workflow node in the decision. The session status is not recomputed.
\- Every successful call, even one that changes nothing, sends a data.updated webhook with trigger "manual_review".
Example call:
curl -X PATCH "https://verification.didit.me/v3/document-ai/11111111-2222-3333-4444-555555555555/documents/44444444-5555-6666-7777-888888888888/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"extracted_data": {"invoice_number": "INV-2026-0042"}, "status": "Approved"}'
What to read from the response:
\- extracted_data: all extracted fields after the merge.
\- status: the document's review status.
\- file_url: the storage path of the file, not a download link. Read the presigned file_url from the session decision to download it.
Failure modes:
\- 400: status is not one of the allowed values, or extracted_data is null (checked before the document is looked up).
\- 401: the API key has expired.
\- 403: missing key (a wrong, revoked or expired key gets 401), a key of another application, a scoped key without decisions: write, or a request from outside the key's IP allowlist.
\- 404: the session does not exist, was deleted, or is outside a scoped key's limits, or the document does not belong to the session.
Side effects: updates the document and sends a data.updated webhook.
For the full integration shape, see /integration/integration-prompt.`
\
Enganxa a
Les claus de camp són les que has configurat per al document al flux de treball. Consulta [Document AI](https://docs.didit.me/ca/core-technology/document-ai/overview.md) per saber com es configuren els documents i els camps, i l'[informe de Document AI](https://docs.didit.me/ca/core-technology/document-ai/report-document-ai.md) per veure on apareix el resultat a la decisió de la sessió.
## OpenAPI
````yaml ca/openapi-25.json PATCH /v3/document-ai/{sessionId}/documents/{documentUuid}/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/document-ai/{sessionId}/documents/{documentUuid}/:
patch:
tags:
- Sessions
summary: Actualitzar un document de Document AI
description: >-
Corregeix els camps que Document AI ha extret d'un document pujat,
defineix el seu estat de revisió, o ambdues coses, en una sessió de KYC
o KYB. `extracted_data` ha de ser un objecte JSON i es fusiona clau per
clau: una clau que enviïs substitueix el valor emmagatzemat (una clau
enviada com a `null` s'emmagatzema com a `null`) i les claus que ometis
mantenen els seus valors. L'estat del document alimenta el resultat de
Document AI del seu node de flux de treball en la decisió de la sessió;
l'estat de la sessió en si no es recalcula. Cada crida satisfactòria,
inclosa una que no canviï res, envia un
[webhook](https://docs.didit.me/ca/integration/webhooks) `data.updated`
amb l'activador `manual_review`. Una clau d'API amb àmbit necessita
`decisions: write`; consulta [Document
AI](https://docs.didit.me/ca/core-technology/document-ai/overview).
operationId: patch_v3_document_ai_document
parameters:
- name: sessionId
in: path
required: true
description: >-
UUID de la sessió de verificació (el `session_id` retornat per `POST
/v3/session/`). Accepta tant IDs de sessió de Verificació d'usuaris
(KYC) com de Verificació d'empreses (KYB): el servidor resol l'ID
entre tots dos tipus de sessió. Ha de ser un UUID ben format; un
valor mal format no coincideix amb la ruta i retorna un `404` en
HTML.
schema:
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
- name: documentUuid
in: path
required: true
description: >-
UUID del document de Document AI
(`document_ai_documents[].items[].uuid` a `GET
/v3/session/{sessionId}/decision/`). Ha de pertànyer a la sessió de
la ruta.
schema:
type: string
format: uuid
example: 44444444-5555-6666-7777-888888888888
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
extracted_data:
type: object
additionalProperties: true
description: >-
Claus de camp (les claus que has configurat per al document)
i els seus valors corregits. Ha de ser un objecte JSON; es
fusiona clau per clau amb les dades emmagatzemades. Omet-lo
en comptes d'enviar `null`, que retorna `400`.
example:
invoice_number: INV-2026-0042
status:
type: string
enum:
- Approved
- Declined
- In Review
- Not Finished
description: Nou estat de revisió del document.
example: Approved
example:
extracted_data:
invoice_number: INV-2026-0042
status: Approved
responses:
'200':
description: Document actualitzat. Retorna el document després de la fusió.
content:
application/json:
schema:
type: object
required:
- uuid
- document_key
- original_filename
- file_url
- status
- extracted_data
properties:
uuid:
type: string
format: uuid
description: Identificador del document.
document_key:
type: string
description: El document configurat al qual correspon aquesta càrrega.
original_filename:
type: string
nullable: true
description: Nom de fitxer amb el qual s'ha penjat el document.
file_url:
type: string
nullable: true
description: >-
Ruta d'emmagatzematge del fitxer carregat. No és un enllaç
de descàrrega: llegeix el camp presignat `file_url` de la
decisió de la sessió per descarregar el fitxer.
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: Estat de revisió del document.
extracted_data:
type: object
nullable: true
additionalProperties: true
description: >-
Tots els camps extrets després de la fusió, indexats per
clau de camp.
example:
uuid: 44444444-5555-6666-7777-888888888888
document_key: invoice
original_filename: invoice-2026-09.pdf
file_url: >-
document_ai/11111111-2222-3333-4444-555555555555-66666666-7777-8888-9999-000000000000.pdf
status: Approved
extracted_data:
invoice_number: INV-2026-0042
total_amount: 1250
issue_date: '2026-09-01'
'400':
description: >-
Error de validació, comprovat abans de cercar el document: `status`
no és un dels valors permesos, o s'ha enviat `extracted_data` com a
`null`.
content:
application/json:
examples:
Invalid status:
summary: status no és a l'enumeració
value:
status:
- '"Rejected" is not a valid choice.'
Null extracted_data:
summary: extracted_data és null
value:
extracted_data:
- This field may not be null.
'401':
description: >-
La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna
`401`: una clau absent, no vàlida o revocada retorna `403`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Expired key:
summary: La data de caducitat de la clau ha passat
value:
detail: This API key has expired.
'403':
description: >-
Fallada d'autenticació o d'autorització. Si falta la clau es retorna
`403`, igual que amb una clau d'una altra aplicació, una clau amb
àmbit sense el permís que necessita aquest endpoint o una
sol·licitud des de fora de la llista d'adreces IP permeses de la
clau; una clau incorrecta, revocada o caducada retorna `401`.
Distingeix-les pel camp `detail`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Missing or invalid credentials:
summary: >-
Falta la capçalera x-api-key, o la clau ha fallat la
validació
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Other application:
summary: >-
Una clau vàlida que pertany a una aplicació diferent de la
de la sessió
value:
detail: You do not have permission to perform this action.
Scoped key without decisions write:
summary: >-
A la clau amb abast li manca el permís d'escriptura de
decisions
value:
detail: This API key has no write access to decisions.
IP not allowed:
summary: >-
Sol·licitud des de fora de la llista d'adreces IP permeses
de la clau
value:
detail: This API key can't be used from this IP address.
'404':
description: >-
La sessió no existeix, s'ha suprimit o queda fora dels límits d'una
clau amb abast limitat, o cap document actual amb aquest UUID li
pertany. La cerca de la sessió s'executa abans de comprovar les
credencials, de manera que un `sessionId` desconegut retorna `404`
fins i tot sense una clau vàlida.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Unknown session:
summary: No existeix cap sessió amb aquest ID, o s'ha suprimit
value:
detail: Not found.
Outside key limits:
summary: >-
La sessió queda fora dels límits d'una clau amb abast
limitat (també es retorna per a una sessió suprimida fa uns
moments)
value:
detail: Session not found.
Unknown document:
summary: documentUuid no pertany a la sessió
value:
detail: Document AI document not found.
'429':
description: >-
S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura
(POST, PATCH, DELETE) per minut per clau d'API. Espera els segons
indicats a `Retry-After` abans de reintentar; les capçaleres
`X-RateLimit-*` mostren el pressupost restant.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Missatge d'error fàcil de llegir.
examples:
Rate limited:
summary: Pressupost per al minut actual esgotat
value:
detail: >-
Write request rate limit exceeded. You can make up to 300
requests per minute.
headers:
Retry-After:
description: Segons que cal esperar abans de reintentar.
schema:
type: integer
minimum: 1
example: 30
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
curl -X PATCH
'https://verification.didit.me/v3/document-ai/11111111-2222-3333-4444-555555555555/documents/44444444-5555-6666-7777-888888888888/'
\
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"extracted_data": {"invoice_number": "INV-2026-0042"}, "status": "Approved"}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.update_document_ai_data(
"11111111-2222-3333-4444-555555555555",
"44444444-5555-6666-7777-888888888888",
extracted_data={"invoice_number": "INV-2026-0042"},
status="Approved",
)
print(result)
- lang: javascript
label: Node.js
source: |-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.updateDocumentAiData(
"11111111-2222-3333-4444-555555555555",
"44444444-5555-6666-7777-888888888888",
{
extracted_data: { invoice_number: "INV-2026-0042" },
status: "Approved",
},
);
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.UpdateDocumentAiData(ctx, \"11111111-2222-3333-4444-555555555555\", \"44444444-5555-6666-7777-888888888888\", didit.SessionsUpdateDocumentAiDataParams{\n\tExtractedData: didit.Some(map[string]any{\"invoice_number\": \"INV-2026-0042\"}),\n\tStatus: didit.Some(didit.SessionsUpdateDocumentAiDataParamsStatus(\"Approved\")),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import java.util.Map;
import me.didit.Didit;
import me.didit.types.SessionsUpdateDocumentAiDataParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.sessions().updateDocumentAiData("11111111-2222-3333-4444-555555555555",
"44444444-5555-6666-7777-888888888888",
SessionsUpdateDocumentAiDataParams.builder()
.extractedData(Map.of("invoice_number", "INV-2026-0042"))
.status(SessionsUpdateDocumentAiDataParams.Status.of("Approved"))
.build());
System.out.println(result);
- lang: php
label: PHP
source: >-
sessions->updateDocumentAiData('11111111-2222-3333-4444-555555555555',
'44444444-5555-6666-7777-888888888888', [
'extracted_data' => ['invoice_number' => 'INV-2026-0042'],
'status' => 'Approved',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.update_document_ai_data(
"11111111-2222-3333-4444-555555555555",
"44444444-5555-6666-7777-888888888888",
extracted_data: { invoice_number: "INV-2026-0042" },
status: "Approved"
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await
client.Sessions.UpdateDocumentAiDataAsync("11111111-2222-3333-4444-555555555555",
"44444444-5555-6666-7777-888888888888", new
SessionsUpdateDocumentAiDataParams
{
ExtractedData = new Dictionary { ["invoice_number"] = "INV-2026-0042" },
Status = new SessionsUpdateDocumentAiDataParamsStatus("Approved"),
});
Console.WriteLine(JsonSerializer.Serialize(result));
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clau d'API de la teva aplicació, des de Developers -> API keys a la
Business Console. La clau primària té accés complet. Una clau amb nom
pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
limitada a determinats fluxos de treball o a sessions aprovades, a una
llista d'adreces IP i a una data de caducitat. 401 significa que la clau
és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
clau, que la clau no té accés a aquest recurs o acció, o que la
sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
ruta de sessió significa que la sessió està fora dels fluxos de treball
o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
URL d'imatge, vídeo i PDF com a null, i una clau sense permís
d'escriptura de sessions rep els enllaços de sessió i els tokens com a
null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.