---
title: 采集 API
canonical: https://developer.unico.io/zh-CN/developers/sdks-and-tools/ios/api-reference/capture-api
locale: zh-CN
generated_by: markdown-export
---

- [/zh-CN/](/zh-CN/)
- [SDK 与工具](/zh-CN/developers/sdks-and-tools/overview)
- [iOS SDK](/zh-CN/developers/sdks-and-tools/ios/requirements)
- API 参考
- 采集 API

# 采集 API

启动会话的方法
| 方法 | 描述 |
| --- | --- |
| `prepareSelfieCamera(_:config:)` | 准备自拍摄像头 |
| `prepareSelfieCamera(_:config:prepareInfo:)` | 准备自拍摄像头并附带 `PrepareInfo` 元数据 |
| `prepareDocumentCamera(_:config:)` | 准备文件摄像头 |
| `open(_:webAppToken:)` | 打开已准备好的自拍摄像头，传入 Create Process 返回的 `process.webAppToken` |
| `openDocument(_:delegate:)` | 使用 `DocumentEnums` 打开已准备好的文件摄像头 |

采集选项 / 参数
**`PrepareInfo`** — 用于标识用户会话的元数据。

| 字段 | 类型 | 是否必填 | 描述 |
| --- | --- | --- | --- |
| `externalUserId` | `String` | 是 | 您系统中的用户标识符。传输前使用 SHA-256 进行哈希处理。 |
| `useCase` | `String` | 否 | 当前运行的上下文或流程的标识符。以明文形式传输。 |

**`DocumentEnums`** — 请参阅 [枚举](/zh-CN/developers/sdks-and-tools/ios/api-reference/enums)。

结果类型和字段
**`SelfieResult`** — 自拍采集成功后返回的对象。

| 字段 | 类型 | 描述 |
| --- | --- | --- |
| `base64` | `String` | Base64 格式的采集图像 |
| `encrypted` | `String` | 需发送至后端的 JWT |

**`SuccessResult`** — 在 Unico API 集成中由 `onSuccess` 返回的对象。

| 字段 | 类型 | 描述 |
| --- | --- | --- |
| `processId` | `String` | 用于通过 REST API 查询验证结果的流程标识符 |

**`DocumentResult`** — 文件采集成功后返回的对象。字段与 `SelfieResult` 相同。

最后更新 于 **2026年10月15日**