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

プロセスの取得

警告

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

API コントラクトでは、POST /processes/v1 のレスポンスがすでに最終結果です。このエンドポイントは再照会のために存在します。例えば、以前に保存したプロセスを確認したい場合や、過去のトランザクションを監査する場合などに使用します。 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"
  },
  "riskLevel": {
    "result": "inconclusive"
  },
  "idFace": {
    "personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "result": "FOUND"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1
}
レスポンスフィールドはAPIKeyによって異なります

上記の例は、すべての可能な機能フィールドを示しています。実際のレスポンスには、APIKey設定で有効になっている機能のフィールドのみが含まれます。無効な機能のフィールドは完全に省略されます。機能の有効化または調整については、Unicoのプロジェクトマネージャーにお問い合わせください。

フィールド型説明
idstring (UUID)プロセス識別子。
statusinteger1（処理中）、2（不一致）、3（成功で完了）、4（キャンセル）、5（エラー）。
unicoId.resultstringyes、no、inconclusive - 本人確認を参照。
riskLevel.resultstringnot_approved、critical_risk、high_risk、inconclusive — 不正リスク分類を参照。
idFace.resultstringFOUND、NOT_FOUND — 顔識別子を参照。
idFace.personIdstring顔の安定した不透明な識別子。idFace.result = FOUND の場合のみ存在します。
identityFraudsters.resultstring非推奨。 代わりに riskLevel を使用してください。現在インテグレーションを進行中のクライアントは、プロジェクトチームと移行を調整しながら引き続き使用できます。
government.serprointegerSerpro類似度スコア（0-100、-1、-2）。ブラジルのみで利用可能。Serpro類似度返却を参照。
livenessinteger1（合格）、2（不合格） - ライブネスを参照。
scoreinteger確率的リスクスコア。unicoId.result = inconclusive かつリスクスコアオーケストレーションがアクティブな場合に存在します。正の値は本人である可能性が高いことを示し、負の値はリスクが高いことを示します。ブラジルのみで利用可能。
400 Bad Request

processId パスパラメータが欠落しているか不正な形式です。以下のエラーコードを参照してください。

403 Forbidden

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

404 Not Found

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

410 Gone

プロセスは存在しますが、エラーが発生しました。id と status: 5 のみを返します。

429 Too Many Requests

レート制限に達しました。システムがHTTP 429エラーを受信した場合、カスケード障害を防ぎ、制限の悪化を避けるためのメカニズムを実装する必要があります。

ベストプラクティス:

  • クールダウン期間（バックオフ）: システムからの後続リクエストを直ちに停止またはスロットルしてください。失敗したリクエストをタイトループで継続的にリトライしないでください。
  • キューイングとスロットリング: 再送信前にトラフィックフローを制御するために、送信リクエストをバッファまたはキューに入れてください。
  • ジッターを含む指数バックオフ: リトライ時に、試行間の待機時間を指数的に増加させ（例: 1秒、2秒、4秒、8秒）、すべてのキューされたリクエストがまったく同じミリ秒にリトライするハード効果を防ぐために小さなランダム遅延（「ジッター」）を追加してください。
警告

バックオフせずにレート制限されたエンドポイントに継続的にアクセスすると、制限期間が延長され、システムの運用スループットに深刻な影響を与える可能性があります。リクエストを適切にスロットリングすることで、よりスムーズで回復力のあるインテグレーションが確保されます。

デフォルトの制限、リクエストの増加、その他の詳細については、レート制限を参照してください。

500 Internal Server Error

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

このエンドポイントの使用タイミング​

APIコントラクトは結果を同期的に返すため、ほとんどのインテグレーションではこのエンドポイントは不要です。以下の場合に使用してください:

  • processId のみを保存し、後で完全な結果を取得する必要がある場合（監査、サポート）。
  • 元のレスポンスが転送中に失われた疑いがある場合（プラットフォームが処理を完了した後のネットワークエラー）。
  • 過去のプロセスをレビューするバックオフィスツールを構築している場合。

エラーコード​

コードメッセージ説明
20023O parâmetro processId não foi informado.プロセスIDパラメータが欠落しています。
20002O parâmetro APIKey não foi informado.リクエストヘッダーにAPIKEYパラメータが欠落しています。
20001O parâmetro authtoken não foi informado.リクエストヘッダーにインテグレーショントークンパラメータが欠落しています。
最終更新 に