セルフィーの取得
Unicoがホストするジャーニー中にユーザーによってキャプチャされた生体認証セルフィーを返します。画像は透かしが適用されたBase64エンコード文字列として返されます。
生体認証キャプチャを実行した、完了済みのすべてのプロセスで利用可能です。スマート再検証ジャーニー(idsmart)も含まれます。生体認証キャプチャなしでプロセスが完了した場合(サイレント認証など)は利用できません。返却するセルフィーが存在しないためです。
エンドポイント
| 環境 | URL |
|---|---|
| 本番 | GET https://api.idcloud.unico.app/client/v1/process/{processId}/selfie |
| サンドボックス | GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}/selfie |
リクエスト
ヘッダー
| ヘッダー | 値 |
|---|---|
Authorization | Bearer <access_token>(認証を参照) |
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
processId | string (UUID) | はい | プロセスの作成が返すプロセス識別子。 |
例
- cURL
- Node.js
curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID/selfie \
-H "Authorization: Bearer $TOKEN"
import fetch from 'node-fetch';
const res = await fetch(
`https://api.idcloud.unico.app/client/v1/process/${processId}/selfie`,
{ headers: { Authorization: `Bearer ${accessToken}` } }
);
const { fileContents, contentType } = await res.json();
// fileContentsはBase64エンコードされた画像文字列です
レスポンス
200 OK
{
"fileContents": "/9j/4AAQSkZJR...",
"contentType": "image/jpeg"
}
| フィールド | 型 | 説明 |
|---|---|---|
fileContents | string (base64) | Base64エンコードされたキャプチャ済みセルフィー。透かしを含みます。 |
contentType | string | 画像のMIMEタイプ — image/jpeg または image/png。 |
エラーコード
メモ
このエンドポイントでは、特定の code や message の値は返されません。
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
processId パスパラメータが欠落しているか、不正な形式です。
Bearerトークンが欠落している、期限切れ、または無効です。認証を参照してください。
このプロセスのセルフィーにアクセスする権限が不足しています。
プロセスが見つからないか、生体認証キャプチャなしでプロセスが完了したため、返却するセルフィーがありません。