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

既存のプロセスを識別子で取得します。APIコントラクトの仕様上、結果はプロセス作成時にすでに同期的に返されているため、このエンドポイントは再照会・監査・サポート対応に使用します。

MarkdownChatGPTClaude
警告

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

エンドポイント​

環境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

このコントラクトは単一で、idCloud.result フィールドが使用されたケイパビリティの統合された判定結果を保持します。

Unicoは、実行されたケイパビリティの結果を単一の idCloud.result に統合します。個々の結果をオーケストレーションする必要はなく、フローの次のステップをすぐに判断できます。

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}
フィールド型説明
idstring (UUID)プロセス識別子。
statusinteger1（処理中）、2（不一致）、3（正常終了）、4（キャンセル）、5（エラー）。
可能な結果の値
idCloud.result意味推奨アクション
approved実在の人物であり、本人確認済み。フローを継続します。
denied本人確認が完了しなかった、ライブネスチェックに失敗した、または重大なリスクが検出された。フローを終了するか、代替フローにリダイレクトします。
critical-risk重大なリスクレベルが検出された。フローを終了するか、手動レビューに振り分けます。
high-risk高いリスクレベルが検出された。手動レビューまたは代替フローに振り分けます。
retry評価に十分なキャプチャまたはスコアが得られなかった。ユーザーに新しいキャプチャを依頼します。
inconclusive判定に十分な証拠がない。手動レビューまたは代替フローに振り分けます。

返される値は、APIKeyに設定されたレシピによって異なります。各レシピが返す結果値については、フローを参照してください。

Brazilブラジルのクライアントはケイパビリティ単位のレスポンスを受け取る場合があります

全体のレスポンス構造は変わらず、単一の結果がデフォルトです。

ブラジルの統合はケイパビリティごとに開かれた結果を受け取る場合があります。APIKeyで有効化された各ケイパビリティがレスポンスに独自のブロックを追加し、無効なケイパビリティのフィールドは省略されます。

{
  "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,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
フィールド型説明
unicoId.resultstringyes、no、inconclusive — 本人確認を参照してください。
riskLevel.resultstringnot_approved、critical_risk、high_risk、inconclusive — 不正リスク分類を参照してください。
idFace.resultstringFOUND — 顔識別子を参照してください。
idFace.personIdstring顔に対する安定した不透明な識別子。idFace.result = FOUND とともに返されます。画像内で顔を識別できない場合、プロセスは idFace ブロックの代わりにエラー 20532 を返します。
identityFraudsters.resultstring非推奨。 代わりに riskLevel を使用してください。既存の統合を持つクライアントは、プロジェクトチームと移行を調整しながら引き続き使用できます。
government.serprointegerSerpro類似度スコア（0〜100、-1、-2）。ブラジルのみで利用可能。Serpro類似度返却を参照してください。
livenessinteger1（合格）、2（不合格） — ライブネスを参照してください。
idAge.resultstringyes、no、inconclusive — 年齢確認を参照してください。ブラジルのみで利用可能。
scoreinteger確率的リスクスコア。unicoId.result = inconclusive かつリスクスコアのオーケストレーションが有効な場合に存在します。正の値は本人である確率が高いことを示し、負の値はリスクが高いことを示します。ブラジルのみで利用可能。
cardholderVerification.resultstringapproved、unsure — Cardholder Verificationを参照してください。status が 3（完了）になるまでは存在しません。ブラジルのみで利用可能。
MexicoメキシコのクライアントはRENAPO検証ブロックを受け取る場合があります

レスポンスの構造は同じままで、idGov ブロックが追加されます。

RENAPO検証が有効なメキシコの統合は、ユーザーのCURPについてRENAPOが保有するレコードを含む追加の idGov ブロックを受け取ります。これは本人確認の結果とは別個の回答です。

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
フィールド型説明
idGovobjectCURPに対するRENAPOのレコード。ケイパビリティが有効でない場合は存在しません。RENAPOが応答しなかった場合は {}。メキシコのみで利用可能。RENAPO検証を参照してください。

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

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.リクエストヘッダーに統合トークンパラメータがありません。

フロー​

レシピとは、プロジェクトのAPIKeyに設定されたケイパビリティ（ライブネス、本人確認、リスクシグナル、ドキュメントなど）の組み合わせです。各プロセスでUnicoが何を実行し、結果がどのように単一の result に統合されるかを定義します — お客様側でオーケストレーションを行う必要はありません。

Unicoは、名前とバージョンが付けられた事前定義済みレシピのカタログを管理しています（例: byunico-idlive-idunico-oneresponse-std）。Score、Serpro、年齢確認を含むものなど、一部はブラジル専用です。

プロセスはどのケイパビリティを実行しますか?

ケイパビリティの組み合わせ（プロジェクトのフロー）は、APIKeyの設定で定義されます。事前定義済みのレシピを確認するか、Unicoのプロジェクト担当者にカスタマイズを相談してください。

最終更新 に