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

プロセスの取得

警告

プロセスを取得する前に、Webhook の設定とフォールバック戦略を確認してください — こちらをクリック

API コントラクトでは、POST /processes/v1 のレスポンスがすでに最終結果です。このエンドポイントは再照会のために存在します。例えば、以前に保存したプロセスを確認したい場合や、過去のトランザクションを監査する場合などに使用します。

エンドポイント

環境URL
本番GET https://api.id.unico.app/processes/v1/{processId}
サンドボックスGET https://api.id.uat.unico.app/processes/v1/{processId}

リクエスト

ヘッダー
ヘッダー
AuthorizationBearer <access_token>
APIKEYプロビジョニング済み API キー。
パスパラメーター
パラメーター必須説明
processIdstring (UUID)はいプロセスの作成 によって返されるプロセス識別子。

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY"

レスポンス

200 OK
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"identityFraudsters": { "result": "inconclusive" },
"government": { "serpro": 87 },
"liveness": 1
}
フィールド説明
idstring (UUID)プロセス識別子。
statusinteger1(処理中)、2(相違あり)、3(正常終了)、4(キャンセル)、5(エラー)。
unicoId.resultstringyesnoinconclusive本人確認 を参照。
identityFraudsters.resultstringyesinconclusiveリスク分類 を参照。
government.serprointegerSerpro の類似スコア(0〜100、-1、-2)。Serpro 類似度 を参照。
livenessinteger1(合格)、2(不合格) — Liveness を参照。
scoreinteger確率的リスクスコア。unicoId.result = inconclusive かつリスクスコアオーケストレーションが有効な場合に存在します。正の値は保有者である可能性が高いことを示し、負の値はリスクが高いことを示します。
400 Bad Request

processId パスパラメーターが欠落しているか、形式が正しくありません。下記のエラーコードを参照してください。

403 Forbidden

Bearer トークンまたは APIKEY が欠落、期限切れ、または無効です。

404 Not Found

processId が存在しないか、認証済みテナントに属していません。

410 Gone

プロセスは存在しますが、エラーが発生しました。idstatus: 5 のみが返されます。

429 Too Many Requests

レート制限に達しました。レート制限を参照してください。

500 Internal Server Error

予期しないサーバーエラーです。

このエンドポイントを使用するタイミング

API コントラクトは同期的に結果を返すため、ほとんどの統合ではこのエンドポイントは必要ありません。以下の場合に使用してください:

  • processId のみを保存しており、後で完全な結果を取得する必要がある場合(監査、サポート)。
  • 元のレスポンスがネットワークエラーで失われた可能性がある場合(プラットフォームが処理を完了した後)。
  • 過去のプロセスを確認するバックオフィスツールを構築している場合。

エラーコード

コードメッセージ説明
20023O parâmetro processId não foi informado.processId パラメーターが欠落しています。
20002O parâmetro APIKey não foi informado.リクエストヘッダーに APIKEY パラメーターが欠落しています。
20001O parâmetro authtoken não foi informado.リクエストヘッダーに統合トークンパラメーターが欠落しています。