---
title: キャプチャAPI
canonical: https://developer.unico.io/ja/developers/sdks-and-tools/ios/api-reference/capture-api
locale: ja
generated_by: markdown-export
---

- [/ja/](/ja/)
- [SDK とツール](/ja/developers/sdks-and-tools/overview)
- [iOS SDK](/ja/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`** — [Enums](/ja/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日**に