> ## 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.
# 更新 Document AI 数据 API
> 在 Didit 中修正 Document AI 证件提取的字段，或设置其审核状态，适用于 KYC 或 KYB 验证会话。
更新 Document AI 数据 API 提示词
将提示词复制到剪贴板
\
\`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.`
\
粘贴到
字段键就是您在工作流中为证件配置的键。有关证件和字段的设置方法，请参阅 [Document AI](https://docs.didit.me/zh/core-technology/document-ai/overview.md)；有关结果在会话决策中的显示位置，请参阅 [Document AI 报告](https://docs.didit.me/zh/core-technology/document-ai/report-document-ai.md)。
## OpenAPI
````yaml zh/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。使用 x-api-key 请求头进行身份验证。
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/document-ai/{sessionId}/documents/{documentUuid}/:
patch:
tags:
- Sessions
summary: 更新 Document AI 证件
description: >-
在 KYC 或 KYB 会话中修正 Document AI
从已上传证件中提取的字段、设置其审核状态，或同时执行这两项操作。`extracted_data` 必须是 JSON
对象，并按键逐一合并：您发送的键会替换已存储的值（以 `null` 发送的键会存储为
`null`），省略的键则保留其原有值。证件状态会在会话决策中作为其工作流节点的 Document AI
结果；会话状态本身不会重新计算。每次成功的调用（包括未更改任何内容的调用）都会发送一个触发器为 `manual_review` 的
`data.updated`
[Webhook](https://docs.didit.me/zh/integration/webhooks)。限定权限范围的 API
密钥需要 `decisions: write` 权限；请参阅 [Document
AI](https://docs.didit.me/zh/core-technology/document-ai/overview)。
operationId: patch_v3_document_ai_document
parameters:
- name: sessionId
in: path
required: true
description: >-
验证会话的 UUID（由 `POST /v3/session/` 返回的
`session_id`）。支持用户验证（KYC）和企业验证（KYB）会话 ID：服务器会跨两种会话类型解析该 ID。必须是格式正确的
UUID；格式不正确的值无法匹配路由并返回 HTML `404`。
schema:
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
- name: documentUuid
in: path
required: true
description: >-
Document AI 证件的 UUID（`GET /v3/session/{sessionId}/decision/` 中的
`document_ai_documents[].items[].uuid`）。它必须属于路径中的会话。
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: >-
字段键（您为该证件配置的键）及其更正后的值。必须是 JSON
对象；按键逐项合并到存储的数据中。请直接省略该字段，而不要发送 `null`，否则会返回 `400`。
example:
invoice_number: INV-2026-0042
status:
type: string
enum:
- Approved
- Declined
- In Review
- Not Finished
description: 证件的新审核状态。
example: Approved
example:
extracted_data:
invoice_number: INV-2026-0042
status: Approved
responses:
'200':
description: 证件已更新。返回合并后的证件。
content:
application/json:
schema:
type: object
required:
- uuid
- document_key
- original_filename
- file_url
- status
- extracted_data
properties:
uuid:
type: string
format: uuid
description: 证件标识符。
document_key:
type: string
description: 此上传内容所对应的已配置证件。
original_filename:
type: string
nullable: true
description: 上传证件时使用的文件名。
file_url:
type: string
nullable: true
description: 已上传文件的存储路径。这不是下载链接：请从会话决策中读取预签名的 `file_url` 来下载文件。
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: 证件的审核状态。
extracted_data:
type: object
nullable: true
additionalProperties: true
description: 合并后提取的所有字段，以字段键作为键名。
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: 验证错误，在查询证件之前进行检查：`status` 不是允许的值之一，或者 `extracted_data` 传入了 `null`。
content:
application/json:
examples:
Invalid status:
summary: status 不在枚举中
value:
status:
- '"Rejected" is not a valid choice.'
Null extracted_data:
summary: extracted_data 为 null
value:
extracted_data:
- This field may not be null.
'401':
description: 作用域 API 密钥已过期。这是唯一返回 `401` 的情况：缺失、无效或已吊销的密钥将返回 `403`。
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: 便于人类阅读的错误消息。
examples:
Expired key:
summary: 密钥的到期日期已过
value:
detail: This API key has expired.
'403':
description: >-
身份验证或授权失败。缺少密钥，以及属于其他应用的密钥、缺少该 endpoint 所需权限的限定作用域密钥和来自该密钥 IP
允许名单之外的请求均返回 `403`；错误、已撤销或已过期的密钥返回 `401`。可通过 `detail` 区分它们。
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: 便于人类阅读的错误消息。
examples:
Missing or invalid credentials:
summary: 缺少 x-api-key 请求头，或该密钥验证失败
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Other application:
summary: 属于与该会话不同应用的有效密钥
value:
detail: You do not have permission to perform this action.
Scoped key without decisions write:
summary: '作用域密钥缺少 decisions: write 权限'
value:
detail: This API key has no write access to decisions.
IP not allowed:
summary: 来自密钥 IP 白名单之外的请求
value:
detail: This API key can't be used from this IP address.
'404':
description: >-
会话不存在、已被删除或超出了限定作用域密钥的限制，或者不包含具有此 UUID
的当前证件。会话查找在凭证检查之前执行，因此即使没有有效密钥，未知的 `sessionId` 也会返回 `404`。
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: 便于人类阅读的错误消息。
examples:
Unknown session:
summary: 不存在具有此 ID 的会话，或该会话已被删除
value:
detail: Not found.
Outside key limits:
summary: 会话超出了限定作用域密钥的限制（对于刚刚删除的会话也会返回此错误）
value:
detail: Session not found.
Unknown document:
summary: documentUuid 不属于该会话
value:
detail: Document AI document not found.
'429':
description: >-
超出速率限制：每个 API 密钥每分钟 300 次写入（POST、PATCH、DELETE）请求。请等待 `Retry-After`
秒后再重试；`X-RateLimit-*` 响应头显示了额度。
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: 便于人类阅读的错误消息。
examples:
Rate limited:
summary: 当前分钟的预算已耗尽
value:
detail: >-
Write request rate limit exceeded. You can make up to 300
requests per minute.
headers:
Retry-After:
description: 重试前需要等待的秒数。
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: >-
您的应用 API 密钥，可在 Business Console 的“开发者 -> API
密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
https://docs.didit.me/console/api-keys。
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.