> ## 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.

# 用户证件：身份证件、地址证明与补充文件

> Didit 用户实体上的身份证件、地址证明及补充文件：说明收集内容、获取方式，以及如何在控制台上传。



用户证件提示
        将提示词复制到剪贴板



      
      

\<pre>

\````# Goal — retrieve user documents and generate compliance PDFs

Documents (ID images, MRZ data, selfies, proof-of-address scans, NFC chip reads) are attached to the **session** that captured them, not directly to the User entity. There is no public "upload document to user" API — capture flows through sessions. You can however list sessions for the user, retrieve each session's decision, and pull signed URLs to the document images.

\## Pattern — list sessions for a user, then read each decision

\```bash
\# 1) List sessions tied to the User entity
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: $DIDIT_API_KEY" \
\--data-urlencode "vendor_data=user-42" \
\--data-urlencode "page_size=50"

\# 2) For each session, retrieve the full decision (V3 plural arrays)
curl https://verification.didit.me/v3/session/$SESSION_ID/decision/ \
-H "x-api-key: $DIDIT_API_KEY"
\```

\## Where documents appear in the V3 decision

Inspect these plural arrays (every per-feature result is plural in V3):

\| Array | Contains |
\|---|---|
\| `id_verifications[]` | Government ID images, OCR fields, MRZ, expiry, issuing country |
\| `liveness_checks[]` | Selfie frames, passive liveness score |
\| `nfc_verifications[]` | NFC chip data, ICAO certificate chain |
\| `proof_of_address_checks[]` | POA document images, extracted address |

Image URLs are short-lived signed URLs — cache the bytes if you need them long-term, or re-fetch the decision when they expire.

\## Generate a PDF report

For a human-readable compliance export (used for SARs, audits, regulator requests):

\```bash
curl https://verification.didit.me/v3/session/$SESSION_ID/generate-pdf/ \
-H "x-api-key: $DIDIT_API_KEY" \
-o session-report.pdf
\```

The PDF includes session details, per-feature results, and embedded document images.

\## Re-verification / new document collection

To collect fresh documents (e.g. expired ID), create a new session for the same `vendor_data` — the new session attaches to the existing User entity:

\```bash
curl -X POST https://verification.didit.me/v3/session/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"workflow_id": "$WORKFLOW_ID", "vendor_data": "user-42"}'
\```

\## Failure modes

\- `404` — wrong `session_id` or wrong `vendor_data` casing.
\- Expired signed image URL — re-fetch the decision to get fresh URLs.
\- `403` on PDF — your API key's role lacks PDF export permission.
\- Document monitoring is on by default and sends no warning before a document expires: when the ID's expiry date passes, the Approved session moves to "Kyc Expired" — see /core-technology/id-verification/document-monitoring-id-verification.

\## Response shape

See /reference/data-models for the full per-feature schema. Each plural-array item carries its own `status`, `document_images[]`, OCR extract, and decision metadata.

\## Sources of truth

\- /sessions-api/retrieve-session — decision schema
\- /reference/data-models — V3 plural-array contract
\- /core-technology/id-verification/overview — ID capture behaviour
\- /core-technology/proof-of-address/overview — POA capture
\- /integration/integration-prompt — canonical end-to-end prompt````

\</pre>



      
      

粘贴到

用户在验证期间上传的每份证件都会永久关联到其 User 实体。本页说明收集的内容、如何获取证件，以及如何手动上传其他证件。## Didit 收集的内容| 证件类型 | 收集时机 | 提取字段 |
| - | - | - |
| **政府签发的身份证件**（护照、国民身份证、驾照、居留许可） | [身份证件验证](https://docs.didit.me/zh/core-technology/id-verification/overview.md)步骤 | 姓名、出生日期、证件号码、签发国家/地区、有效期、（如有）MRZ |
| **自拍照 / 活体检测帧** | [活体检测](https://docs.didit.me/zh/core-technology/liveness/overview.md)步骤 | 最大人脸裁剪图、被动活体评分 |
| **地址证明（POA）** | [POA](https://docs.didit.me/zh/core-technology/proof-of-address/overview.md)步骤 | 姓名、地址、签发机构、证件日期 |
| **NFC 芯片读取** | [NFC 验证](https://docs.didit.me/zh/core-technology/nfc-verification/overview.md)步骤 | 芯片数据、ICAO 证书链、与 OCR 结果的比对 |
| **其他证件** | 分析师请求或自定义工作流步骤 | 适用时进行 OCR，否则按原样存储 |[支持的证件类型](https://docs.didit.me/zh/core-technology/id-verification/supported-documents-id-verification.md)涵盖完整的国家/地区 × 证件类型矩阵（220+ 个国家/地区，14,000+ 种证件）。## 获取证件证件与收集它的**会话**相关联，而不是直接与用户关联。要列出某个用户的所有证件，请执行以下步骤：**1. 列出用户的会话**```bash theme={null}
curl -G https://verification.didit.me/v3/sessions/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "vendor_data=user-42"
```**2. 获取每个会话的决策**每个会话决策都包含已收集证件的 URL。```bash theme={null}
curl https://verification.didit.me/v3/session/{session_id}/decision/ \
  -H "x-api-key: YOUR_API_KEY"
```检查响应中的 `id_verification.document_images`、`proof_of_address.document_images` 和 `liveness.images` 字段。**3. 使用签名 URL**响应中的图片 URL 是短期有效的签名 URL。请将其缓存在客户端以供使用，或在过期后重新获取决策。## 生成 PDF 报告如需为某个会话导出便于阅读的完整记录（包括所有证件），请使用：**`GET /v3/session/{session_id}/generate-pdf/`**该接口返回一份 PDF，其中包含会话详情、功能结果以及嵌入的证件图片。适用于合规审计、SAR 附件和监管备案。## 从控制台上传证件合规人员可以为某个用户或某个活跃会话上传其他证件：1. 进入 *Users → \[user] → Documents → Upload document*。
2. 选择证件类型（ID、POA 或自定义）。
3. 上传文件；对于受支持的类型，会自动运行 OCR。
4. 证件会关联到最近的会话（或者您可以创建一个修复会话）。> [!NOTE]
>
> 证件上传界面仅在控制台中提供，没有可将证件直接关联到用户的公开 API 端点。请将会话作为所有证件采集的入口。## 证件交叉核验当一个会话收集了多种类型的证件时，Didit 会进行交叉核验：- **ID ↔ 活体检测**：证件上的人脸与活体检测自拍照一致。
- **ID ↔ 地址证明**：地址证明上的姓名与从证件中提取的姓名一致。
- **ID ↔ NFC**：MRZ / 视觉数据与 NFC 芯片数据一致。不一致之处会以警告的形式显示在会话决策中，并可配置为触发人工审核。## 证件监控与重新验证对于需要持续确认证件有效性的场景（例如已过期的证件）：- **证件有效期**会在每份已验证的身份证件上记录。查询会话决策中的 `expiration_date` 字段即可获取。
- **证件监控**：默认开启且自动运行，无需手动启用。证件到期日期过后，状态为 `"Approved"` 的会话会变为 `"Kyc Expired"`，身份证件验证结果会新增 `DOCUMENT_EXPIRED` 警告，并触发一次 `status.updated` Webhook。到期日期之前不会发送任何警告。
- **关闭监控**：在[身份证件验证设置](https://docs.didit.me/zh/core-technology/id-verification/overview.md)中，针对对应的国家/地区和证件类型，将 **Expiration mode** 设置为 **Allow expired**。默认的 **Reject expired** 才会进行监控。以 **Allow expired** 接受的证件永远不会被监控。
- **重新验证**：使用相同的 `vendor_data` 发起新会话，以刷新证件。## 证件地理位置[身份证件地理位置](https://docs.didit.me/zh/core-technology/id-verification/document-geolocation-id-verification.md)检查会将提交者的 IP 位置与证件的签发国家/地区进行比较。结果会附在会话决策中。## 隐私与数据保留- 所有证件均在静态存储时加密。
- 图片访问通过短期有效的签名 URL 进行。
- 数据保留遵循应用的[数据保留](https://docs.didit.me/zh/console/data-retention.md)政策。
- 用户有权请求删除；删除会移除图片、OCR 提取结果和 NFC 数据。## 后续步骤> [card] [身份证件验证](https://docs.didit.me/zh/core-technology/id-verification/overview.md)
>
> 了解证件采集和 OCR 的工作方式。> [card] [地址证明](https://docs.didit.me/zh/core-technology/proof-of-address/overview.md)
>
> POA 证件采集。> [card] [会话决策](https://docs.didit.me/zh/sessions-api/retrieve-session.md)
>
> GET /v3/session/{id}/decision/ 参考文档。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.