証跡セットの取得
生体認証キャプチャ中に生成された証跡バンドルを返します。これは、ライブネス検出が管理された条件下で実行されたことを証明するために使用される、キャプチャ画像、メタデータ、キャプチャ成果物を含むパッケージです。
完了したプロセス(state = PROCESS_STATE_FINISHED)でのみ利用可能です。
エンドポイント
| 環境 | URL |
|---|---|
| 本番 | GET https://api.idcloud.unico.app/client/v1/process/{processId}/evidenceset |
| サンドボックス | GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}/evidenceset |
リクエスト
ヘッダー
| ヘッダー | 値 |
|---|---|
Authorization | Bearer <access_token>(認証を参照) |
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
processId | string (UUID) | はい | プロセスの作成が返すプロセス識別子。 |
例
- cURL
- Node.js
curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID/evidenceset \
-H "Authorization: Bearer $TOKEN" \
| jq -r .fileContents | base64 --decode > evidence-set.pdf
import { writeFile } from 'node:fs/promises';
async function getEvidenceSet(processId) {
const response = await fetch(
`https://api.idcloud.unico.app/client/v1/process/${processId}/evidenceset`,
{ headers: { Authorization: `Bearer ${accessToken}` } }
);
if (!response.ok) throw new Error(`Get Evidence Set failed with ${response.status}`);
const { fileContents } = await response.json();
// fileContentsはBase64エンコードされたPDFファイルです
return Buffer.from(fileContents, 'base64');
}
// PDFをディスクに保存
await writeFile(`evidence-set-${processId}.pdf`, await getEvidenceSet(processId));
// またはブラウザに送信する場合(Express)
app.get('/processes/:id/evidence-set', async (req, res) => {
const pdf = await getEvidenceSet(req.params.id);
res
.type('application/pdf') // contentTypeは転送しないこと: APIは "x-pdf" を返します
.set('Content-Disposition', 'inline; filename="evidence-set.pdf"')
.send(pdf);
});
レスポンス
200 OK
{
"fileContents": "JVBERi0xLjMNCi...",
"contentType": "x-pdf"
}
| フィールド | 型 | 説明 |
|---|---|---|
fileContents | string (base64) | Base64エンコードされた証跡セットのPDF。 |
contentType | string | 現在は x-pdf を返します。 |
PDFの構築
x-pdf は有効なMIMEタイプではなく、ブラウザはこれを認識しません。contentType をブラウザに転送しないでください。fileContents をBase64からデコードし、上記のNode.jsの例のように application/pdf としてバイト列を提供してください。
エラーコード
メモ
このエンドポイントでは、特定の code や message の値は返されません。
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 500 Internal Server Error
processId パスパラメータが欠落しているか、不正な形式です。
Bearerトークンが欠落している、期限切れ、または無効です。認証を参照してください。
プロセスが見つからないか、証跡セットがまだ利用できません(プロセスが完了していません)。
| コード | メッセージ | 説明 |
|---|---|---|
99999 | Internal failure! Try again later | 内部エラーが発生した場合。 |