> ## 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.
# Mettre à jour les données Document AI via l'API
> Corrigez les champs extraits par Didit d'un document Document AI, ou définissez son statut de revue, sur une session de vérification KYC ou KYB.
Prompt de l'API de mise à jour des données Document AI
Copier le prompt dans le presse-papiers
\
\`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.`
\
Coller dans
Les clés des champs sont celles que vous avez configurées pour le document dans le workflow. Consultez [Document AI](https://docs.didit.me/fr/core-technology/document-ai/overview.md) pour savoir comment les documents et les champs sont configurés, et le [rapport Document AI](https://docs.didit.me/fr/core-technology/document-ai/report-document-ai.md) pour savoir où le résultat apparaît dans la décision de la session.
## OpenAPI
````yaml fr/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 vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/document-ai/{sessionId}/documents/{documentUuid}/:
patch:
tags:
- Sessions
summary: Mettre à jour un document Document AI
description: >-
Corriger les champs extraits par Document AI à partir d'un document
téléversé, définir son statut d'examen, ou les deux, sur une session KYC
ou KYB. `extracted_data` doit être un objet JSON et est fusionné clé par
clé : une clé envoyée remplace la valeur stockée (une clé envoyée avec
`null` est stockée sous la forme `null`) et les clés omises conservent
leur valeur. Le statut du document alimente le résultat Document AI de
son nœud de workflow dans la décision de la session ; le statut de la
session lui-même n'est pas recalculé. Chaque appel réussi, y compris
s'il ne modifie rien, envoie un
[webhook](https://docs.didit.me/fr/integration/webhooks) `data.updated`
avec le déclencheur `manual_review`. Une clé API restreinte nécessite
`decisions: write` ; voir [Document
AI](https://docs.didit.me/fr/core-technology/document-ai/overview).
operationId: patch_v3_document_ai_document
parameters:
- name: sessionId
in: path
required: true
description: >-
UUID de la session de vérification (le `session_id` renvoyé par
`POST /v3/session/`). Accepte les identifiants de session de
Vérification des utilisateurs (KYC) et de Vérification d'entreprise
(KYB) : le serveur résout l'identifiant pour les deux types de
session. Doit être un UUID bien formé ; une valeur malformée ne
correspond pas à la route et renvoie une erreur HTML `404`.
schema:
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
- name: documentUuid
in: path
required: true
description: >-
UUID du document Document AI (`document_ai_documents[].items[].uuid`
dans `GET /v3/session/{sessionId}/decision/`). Il doit appartenir à
la session présente dans le chemin.
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: >-
Clés de champ (les clés que vous avez configurées pour le
document) et leurs valeurs corrigées. Doit être un objet
JSON ; fusionné clé par clé dans les données stockées.
Omettez-le plutôt que d'envoyer `null`, qui renvoie un code
`400`.
example:
invoice_number: INV-2026-0042
status:
type: string
enum:
- Approved
- Declined
- In Review
- Not Finished
description: Nouveau statut d'examen du document.
example: Approved
example:
extracted_data:
invoice_number: INV-2026-0042
status: Approved
responses:
'200':
description: Document mis à jour. Renvoie le document après la fusion.
content:
application/json:
schema:
type: object
required:
- uuid
- document_key
- original_filename
- file_url
- status
- extracted_data
properties:
uuid:
type: string
format: uuid
description: Identifiant du document.
document_key:
type: string
description: Le document configuré auquel correspond ce téléversement.
original_filename:
type: string
nullable: true
description: Nom de fichier avec lequel le document a été téléversé.
file_url:
type: string
nullable: true
description: >-
Chemin de stockage du fichier téléversé. Il ne s'agit pas
d'un lien de téléchargement : lisez l'URL pré-signée
`file_url` depuis la décision de session pour télécharger
le fichier.
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: Statut d'examen du document.
extracted_data:
type: object
nullable: true
additionalProperties: true
description: >-
Tous les champs extraits après la fusion, indexés par clé
de champ.
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: >-
Erreur de validation, vérifiée avant la recherche du document :
`status` ne fait pas partie des valeurs autorisées, ou
`extracted_data` envoyé avec la valeur `null`.
content:
application/json:
examples:
Invalid status:
summary: status n'est pas dans l'enum
value:
status:
- '"Rejected" is not a valid choice.'
Null extracted_data:
summary: extracted_data est null
value:
extracted_data:
- This field may not be null.
'401':
description: >-
La clé API restreinte a expiré. C'est le seul cas qui renvoie `401`
: une clé manquante, invalide ou révoquée renvoie `403`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Message d'erreur lisible par l'humain.
examples:
Expired key:
summary: La date d'expiration de la clé est dépassée
value:
detail: This API key has expired.
'403':
description: >-
Échec d'authentification ou d'autorisation. Une clé manquante
renvoie `403`, tout comme la clé d'une autre application, une clé
restreinte ne disposant pas de l'autorisation requise par cet
endpoint, ou une requête provenant de l'extérieur de la liste
d'adresses IP autorisées de la clé ; une clé incorrecte, révoquée ou
expirée renvoie `401`. Distinguez-les grâce au champ `detail`.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Message d'erreur lisible par l'humain.
examples:
Missing or invalid credentials:
summary: Aucun en-tête x-api-key, ou la validation de la clé a échoué
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Other application:
summary: >-
Une clé valide qui appartient à une application différente
de la session
value:
detail: You do not have permission to perform this action.
Scoped key without decisions write:
summary: 'La clé restreinte ne dispose pas de decisions: write'
value:
detail: This API key has no write access to decisions.
IP not allowed:
summary: >-
Requête provenant de l'extérieur de la liste d'adresses IP
autorisées de la clé
value:
detail: This API key can't be used from this IP address.
'404':
description: >-
La session n'existe pas, a été supprimée ou se trouve en dehors des
limites d'une clé restreinte, ou aucun document actuel avec cet UUID
ne lui appartient. La recherche de session s'exécute avant la
vérification des identifiants, donc un `sessionId` inconnu renvoie
`404` même sans clé valide.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Message d'erreur lisible par l'humain.
examples:
Unknown session:
summary: Aucune session avec cet ID n'existe, ou elle a été supprimée
value:
detail: Not found.
Outside key limits:
summary: >-
La session se trouve en dehors des limites d'une clé
restreinte (également renvoyée pour une session supprimée il
y a quelques instants)
value:
detail: Session not found.
Unknown document:
summary: documentUuid n'appartient pas à la session
value:
detail: Document AI document not found.
'429':
description: >-
Limite de débit dépassée : 300 requêtes d'écriture (POST, PATCH,
DELETE) par minute par clé API. Attendez `Retry-After` secondes
avant de réessayer ; les en-têtes `X-RateLimit-*` indiquent le
budget.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: Message d'erreur lisible par l'humain.
examples:
Rate limited:
summary: Budget épuisé pour la minute en cours
value:
detail: >-
Write request rate limit exceeded. You can make up to 300
requests per minute.
headers:
Retry-After:
description: Secondes à attendre avant de réessayer.
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 clé API de votre application, issue de Développeurs -> Clés API dans
la Business Console. La clé principale dispose d'un accès complet. Une
clé nommée peut être restreinte : aucun, lecture ou écriture par
ressource, limitée à certains workflows ou aux sessions approuvées, à
une liste d'adresses IP et à une date d'expiration. 401 signifie que la
clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
une route de session signifie que la session est hors des workflows ou
des statuts de la clé. Une clé sans accès aux médias reçoit les URL
d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
aux sessions reçoit les liens et tokens de session à null. Voir
https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.