> ## 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 para actualizar datos de Document AI
> Corrige los campos que Didit extrajo de un documento con Document AI o define su estado de revisión en una sesión de verificación KYC o KYB.
Prompt de la API para actualizar datos de Document AI
Copiar el prompt al portapapeles
\
\`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.`
\
Pegar en
Las claves de los campos son las que configuraste para el documento en el flujo. Consulta [Document AI](https://docs.didit.me/es/core-technology/document-ai/overview.md) para ver cómo se configuran los documentos y los campos, y el [informe de Document AI](https://docs.didit.me/es/core-technology/document-ai/report-document-ai.md) para ver dónde aparece el resultado en la decisión de la sesión.
## OpenAPI
````yaml es/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ón de identidad. Autentícate con el encabezado x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/document-ai/{sessionId}/documents/{documentUuid}/:
patch:
tags:
- Sessions
summary: Actualizar un documento de Document AI
description: >-
Corrige los campos que Document AI extrajo de un documento subido,
establece su estado de revisión, o ambas cosas, en una sesión KYC o KYB.
`extracted_data` debe ser un objeto JSON y se combina clave por clave:
una clave que envías reemplaza el valor guardado (una clave enviada como
`null` se guarda como `null`) y las claves que omites conservan sus
valores. El estado del documento alimenta el resultado de Document AI de
su nodo del flujo en la decisión de la sesión; el estado de la propia
sesión no se recalcula. Cada llamada exitosa, incluso una que no cambia
nada, envía un [webhook](https://docs.didit.me/es/integration/webhooks)
`data.updated` con el disparador `manual_review`. Una clave de API con
alcance limitado necesita `decisions: write`; consulta [Document
AI](https://docs.didit.me/es/core-technology/document-ai/overview).
operationId: patch_v3_document_ai_document
parameters:
- name: sessionId
in: path
required: true
description: >-
UUID de la sesión de verificación (el `session_id` que devuelve
`POST /v3/session/`). Acepta ID de sesión tanto de Verificación de
usuarios (KYC) como de Verificación de empresas (KYB): el servidor
resuelve el ID en ambos tipos de sesión. Debe ser un UUID con
formato válido; un valor mal formado no coincide con la ruta y
devuelve un `404` en HTML.
schema:
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
- name: documentUuid
in: path
required: true
description: >-
UUID del documento de Document AI
(`document_ai_documents[].items[].uuid` en `GET
/v3/session/{sessionId}/decision/`). Debe pertenecer a la sesión
indicada en 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: >-
Claves de campo (las claves que configuraste para el
documento) y sus valores corregidos. Debe ser un objeto
JSON; se combina clave por clave con los datos almacenados.
Omítelo en lugar de enviar `null`, que devuelve `400`.
example:
invoice_number: INV-2026-0042
status:
type: string
enum:
- Approved
- Declined
- In Review
- Not Finished
description: Nuevo estado de revisión del documento.
example: Approved
example:
extracted_data:
invoice_number: INV-2026-0042
status: Approved
responses:
'200':
description: >-
Documento actualizado. Devuelve el documento después de la
combinación.
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 documento.
document_key:
type: string
description: El documento configurado al que corresponde esta carga.
original_filename:
type: string
nullable: true
description: Nombre de archivo con el que se subió el documento.
file_url:
type: string
nullable: true
description: >-
Ruta de almacenamiento del archivo subido. No es un enlace
de descarga: lee el `file_url` prefirmado de la decisión
de la sesión para descargar el archivo.
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: Estado de revisión del documento.
extracted_data:
type: object
nullable: true
additionalProperties: true
description: >-
Todos los campos extraídos tras la combinación, indexados
por clave de campo.
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ón, comprobado antes de buscar el documento:
`status` no es uno de los valores permitidos, o `extracted_data` se
envía como `null`.
content:
application/json:
examples:
Invalid status:
summary: status no está en el enum
value:
status:
- '"Rejected" is not a valid choice.'
Null extracted_data:
summary: extracted_data es null
value:
extracted_data:
- This field may not be null.
'401':
description: >-
La clave de API con alcance limitado ha expirado. Este es el único
caso que devuelve `401`: una clave ausente, no válida o revocada
devuelve `403`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Mensaje de error legible.
examples:
Expired key:
summary: La fecha de caducidad de la clave ya pasó
value:
detail: This API key has expired.
'403':
description: >-
Fallo de autenticación o autorización. Si falta la clave, se
devuelve `403`, al igual que con una clave de otra aplicación, una
clave con alcance limitado sin el permiso que necesita este endpoint
y una solicitud desde fuera de la lista de IP permitidas de la
clave; una clave incorrecta, revocada o expirada devuelve `401`.
Distínguelos por `detail`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Mensaje de error legible.
examples:
Missing or invalid credentials:
summary: >-
Falta el encabezado x-api-key, o la clave no superó la
validación
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Other application:
summary: >-
Una clave válida que pertenece a una aplicación distinta de
la de la sesión
value:
detail: You do not have permission to perform this action.
Scoped key without decisions write:
summary: 'A la clave con alcance limitado le falta decisions: write'
value:
detail: This API key has no write access to decisions.
IP not allowed:
summary: >-
Solicitud desde fuera de la lista de IP permitidas de la
clave
value:
detail: This API key can't be used from this IP address.
'404':
description: >-
La sesión no existe, se ha eliminado o está fuera de los límites de
una clave con alcance restringido, o no le pertenece ningún
documento actual con este UUID. La búsqueda de la sesión se ejecuta
antes de comprobar la credencial, por lo que un `sessionId`
desconocido devuelve `404` incluso sin una clave válida.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Mensaje de error legible.
examples:
Unknown session:
summary: No existe ninguna sesión con este ID, o se eliminó
value:
detail: Not found.
Outside key limits:
summary: >-
La sesión está fuera de los límites de una clave con alcance
restringido (también se devuelve para una sesión eliminada
hace unos instantes)
value:
detail: Session not found.
Unknown document:
summary: documentUuid no pertenece a la sesión
value:
detail: Document AI document not found.
'429':
description: >-
Límite de solicitudes superado: 300 solicitudes de escritura (POST,
PATCH, DELETE) por minuto por clave de API. Espera los segundos
indicados en `Retry-After` antes de reintentar; los encabezados
`X-RateLimit-*` muestran el presupuesto.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Mensaje de error legible.
examples:
Rate limited:
summary: Presupuesto del minuto actual agotado
value:
detail: >-
Write request rate limit exceeded. You can make up to 300
requests per minute.
headers:
Retry-After:
description: Segundos que hay que esperar antes 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 clave de API de tu aplicación, que encontrarás en Developers -> API
keys en la Business Console. La clave principal tiene acceso completo.
Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
a una lista de direcciones IP y a una fecha de caducidad. 401 significa
que la clave es incorrecta, se revocó o expiró; 403 significa que no se
envió ninguna clave, que la clave no tiene acceso a este recurso o
acción, o que la solicitud provino de una dirección fuera de su lista de
IP; 404 en una ruta de sesión significa que la sesión está fuera de los
flujos o estados de la clave. Una clave sin acceso a contenido
multimedia recibe las URL de imágenes, videos y PDF como null, y una
clave sin permiso de escritura en sesiones recibe los enlaces y tokens
de sesión como null. Consulta https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.