メインコンテンツへスキップ
プロセスの取得GET

Human Token プロセスを識別子で取得します。ユーザーが Human Token Journey から戻った後や、API Only の結果を再照会する際に使用します。

Markdown

エンドポイント​

環境URL
本番GET https://humantoken.unico.app/client/v1/process/{processId}

リクエスト​

ヘッダー
ヘッダー値
x-unico-accesskey<your_access_key>(認証を参照)
パスパラメータ
パラメータ型必須説明
processIdstring (UUID)はいプロセスの作成で返されたプロセス識別子。

例​

curl -X GET https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY"

レスポンス​

200 OK

レスポンスの形式はプロセスの作成と同じです。data の構造は、プロセス作成時に使用されたフローによって異なります。

標準フロー(api+humantoken、api+liveness+humantoken、humantoken):

{
"id": "6ed74799-4c2f-4023-b43f-a73cf7c847b2",
"state": "PROCESS_STATE_FINISHED",
"data": {
"humanToken": {
"value": "3f9a1c7e5b2d4086a1e3c5f7092b4d6e8a0c2e4f6183a5c7e9b1d3f5072a4c6e",
"status": "validated"
}
}
}

再検証フロー(api+liveness+humantoken+revalidation、humantoken+revalidation):

{
"id": "cb0472c0-6dbc-46c6-b830-2be7edc35424",
"state": "PROCESS_STATE_FINISHED",
"data": {
"humanTokenMatch": "true"
}
}
フィールド型説明
idstring (UUID)プロセス識別子。
statestringプロセスの状態。state の値を参照してください。
data.​humanToken.​valuestring標準フローのみ。顔の安定した不透明な識別子(最大100文字)。同じ人物は常に同じ値に解決されます。
data.​humanTokenMatchstring再検証フローのみ。セルフィーが参照された humanToken と一致する場合は "true"、一致しない場合は "false"。
state の値
値意味
PROCESS_STATE_UNSPECIFIED状態が設定されていません。
PROCESS_STATE_CREATEDプロセスは作成済みで、新しいセッションをまだ受け付けます。data は {} です。
PROCESS_STATE_FINISHEDプロセスは完了し、新しいセッションを受け付けません。標準フローでは、Human Token が生成された場合に data.humanToken が含まれます。再検証フローでは、data.humanTokenMatch がセルフィーが参照トークンと一致したかどうかを示します。それ以外の場合 data は {} です。
PROCESS_STATE_FAILEDプロセスは失敗しました。data は {} です。
PROCESS_STATE_CANCELEDプロセスはキャンセルされました。data は {} です。
PROCESS_STATE_AWAITING_FOR_DOCUMENTプロセスは本人確認書類を待っています。data は {} です。
警告

data.humanToken.value を使用する前に、必ず空でないことを確認してください。

エラーコード​

コードメッセージ説明
3process id is invalidプロセス ID が無効な場合。

次のステップ​

  • 新しいセルフィーを送信するには、プロセスの作成に戻ってください。
  • humanToken が何を表すか、また生成されない場合については、Human Token の概要を参照してください。