メインコンテンツへスキップ

証跡セットの取得

Markdown

生体認証キャプチャ中に生成された証跡バンドルを返します。これは、ライブネス検出が管理された条件下で実行されたことを証明するために使用される、キャプチャ画像、メタデータ、キャプチャ成果物を含むパッケージです。

完了したプロセス(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

リクエスト​

ヘッダー
ヘッダー値
AuthorizationBearer <access_token>(認証を参照)
パスパラメータ
パラメータ型必須説明
processIdstring (UUID)はいプロセスの作成が返すプロセス識別子。

例​

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

レスポンス​

200 OK
{
"fileContents": "JVBERi0xLjMNCi...",
"contentType": "x-pdf"
}
フィールド型説明
fileContentsstring (base64)Base64エンコードされた証跡セットのPDF。
contentTypestring現在は x-pdf を返します。
PDFの構築

x-pdf は有効なMIMEタイプではなく、ブラウザはこれを認識しません。contentType をブラウザに転送しないでください。fileContents をBase64からデコードし、上記のNode.jsの例のように application/pdf としてバイト列を提供してください。

エラーコード​

メモ

このエンドポイントでは、特定の code や message の値は返されません。

processId パスパラメータが欠落しているか、不正な形式です。

次のステップ​