概要
コントラクトの選択
コントラクトの選択は、生体認証キャプチャが行われる場所の結果であり、独立した決定ではありません。以下の表をガイドとして使用してください。
| コントラクト | 使用する場面 | キャプチャ | フロー |
|---|---|---|---|
| Web & SDK | キャプチャジャーニーが Unico によってホストされている場合(Web iFrame、リダイレクト、またはネイティブ SDK) | Unico が制御 | キャプチャ前にプロセスを作成 → ユーザーがジャーニーを経由 → コールバックまたはポーリングで結果が返される |
| API | アプリケーションがキャプチャを制御し(Unico SDK を使用するかどうかに関わらず)、呼び出しで直接画像を送信する場合 | クライアントが制御 | プロセス作成と同時に画像を送信 → 同期的に結果が返される |
ホストと環境
| コントラクト | サンドボックスホスト | 本番ホスト |
|---|---|---|
| Web & SDK | https://api.idcloud.uat.unico.app | https://api.idcloud.unico.app |
| API | https://api.id.uat.unico.app | https://api.id.unico.app |
| OAuth2 / Token | https://identityhomolog.acesso.io | https://identity.acesso.io |
詳細は環境を参照してください。
認証
すべての Unico コントラクトは、urn:ietf:params:oauth:grant-type:jwt-bearer を使用した OAuth2 で取得した Bearer トークン(JWT) を使用します。
詳細は認証を参照してください。
コントラクト間のペイロードの違い
同じ概念的な操作(「本人確認プロセスの作成」)は、各コントラクトで異なる形式をとります。統合間で移行する際の簡単なリファレンスとして以下の表を使用してください。
プロセス作成
| 側面 | Web & SDK | API |
|---|---|---|
| エンドポイント | POST /client/v1/process | POST /processes/v1 |
| 認証 | Authorization: Bearer <jwt> | Authorization: Bearer <jwt> + APIKEY |
| 画像 | 送信しない(Unico のジャーニーでキャプチャ) | imageBase64 として送信 |
| ユーザー識別 | person.duiType + person.duiValue | subject.code(CPF / CURP) |
| ドキュメントタイプ | CPF、CURP、SSN、NIN、DNI、NIK | CPF、CURP のみ |
| パイプライン定義 | flow(列挙型、30 以上の値) | APIKEY に暗黙的(機能) |
| コールバック | callbackUri(ユーザーリダイレクト) | なし(同期) |
| Webhook | Webhook v1(最終結果) | Webhook v1(オプション) |
| ジャーニー URL を返す | あり(userRedirectUrl) | なし |
| 結果 | 非同期(GET ポーリングまたは Webhook) | 同期(レスポンスで) |
| SDK トークン | あり(token、webAppToken) | なし |
結果の取得
| 側面 | Web & SDK | API |
|---|---|---|
| エンドポイント | GET /client/v1/process/\{id\} | GET /processes/v1/\{id\}(作成レスポンスにも含まれる) |
| ステータス | state + result(プレフィックス付き列挙型) | status(1、3、5) |
| 結果構造 | process.authenticationInfo.{capability}Result の下にネスト | フラット:unicoId、liveness、government、identityFraudsters |
| ドキュメント | services[].documents[](OCR 付き RG/CNH) | 別エンドポイント(GET /processes/v1/\{id\}/document) |
次のステップ
- 認証 — OAuth2 フローと JWT 生成
- 環境 — サンドボックスと本番
- Postman コレクション — すぐに使えるコレクション
- Webhook とイベント — 非同期結果配信
- SDK とツール — Web SDK、Android、iOS、Flutter