結果のシミュレーション(テストモック)
サンドボックスでは、実際の生体認証キャプチャに依存せずにプロセス結果をシミュレートできます。プロセスの作成のリクエストボディに expected_result フィールドを追加してください — 統合の残りの部分(SDKレンダリング、生体認証キャプチャ、プロセスの取得)は、実際のフローとまったく同じです。
モックは生体認証キャプチャのステップをスキップしません。ユーザー(またはテストスクリプト)は通常のフローを完了する必要があります — 変わるのは、完了時にプロセスが実際の評価結果の代わりに expected_result で定義された値を返す点です。
各 flow は、その設定方法に応じて、以下の2つのフォーマットのうちいずれか一つのみを受け付けます:
| フォーマット | 使用するタイミング |
|---|---|
id_cloud_one_result | 単一の結果(承認、拒否、高リスクなど)を返すフロー |
authentication_info | 個別のシグナル(UnicoId、Trust、Liveness、IdAge、IdFaceなど)を返すフロー |
flow に一致しないフォーマットを送信した場合、または両方を同時に送信した場合は、エラーになります — エラーを参照してください。
エンドポイント
| 環境 | URL |
|---|---|
| サンドボックス | POST https://api.idcloud.uat.unico.app/client/v1/process |
モックはサンドボックスでのみ利用可能です。本番環境では、expected_result フィールドは拒否されます。
flow が単一の承認スタイルの結果を返す場合に使用します。
ボディパラメータ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
expected_result.id_cloud_one_result | string | はい | シミュレートする単一の結果。flow が実際に生成する結果である必要があります — 認識される結果については、フローの設定を確認してください。 |
例
curl -X POST https://api.idcloud.uat.unico.app/client/v1/process \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"expected_result": {
"id_cloud_one_result": "PROCESS_RESULT_APPROVED"
}
// ... 残りのパラメータは、実際のプロセスの作成呼び出しで使用するものと同じです
}'
レスポンス(200 OK)
{
"process": {
"id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
"state": "PROCESS_STATE_FINISHED",
"result": "PROCESS_RESULT_OK",
"flow": "your-sandbox-flow",
"simulated": true,
"capacities": ["PROCESS_CAPACITY_IDCHECK"],
"person": { "duiType": "DUI_TYPE_BR_CPF", "duiValue": "12345678909" }
}
}
simulated: true は、このプロセスが実際の評価ではなくシミュレートされた結果であることを示します。
id_cloud_one_result に指定できる値は、結果の解釈で説明されているプロセス結果値と同じです — flow が実際に認識する結果のみを送信してください。
flow が単一の結果ではなく個別のシグナルを返す場合に使用します。
flow が通常返すすべてのシグナルが authentication_info に含まれている必要があります。 一部のみを送信することは拒否されます — 1つのシグナルだけをモックして、残りを実際の評価に任せることはできません。
trust_result と identity_fraudsters_resulttrust_result と identity_fraudsters_result は同じシグナル(不正利用の兆候)を表します: trust_result はネガティブ側を、identity_fraudsters_result はポジティブ側をカバーします。シミュレートしたい結果に一致する方を使用してください。
各フィールドに指定できる値については、authenticationInfo内のケイパビリティ別結果を参照してください。
フリクションレスフローはこのフォーマットではサポートされていません — サポートされていないシグナルを参照してください。
例
curl -X POST https://api.idcloud.uat.unico.app/client/v1/process \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"expected_result": {
"authentication_info": {
"authentication_result": "AUTHENTICATION_RESULT_POSITIVE",
"liveness_result": "LIVENESS_RESULT_LIVE",
"id_age_result": "ID_AGE_RESULT_POSITIVE"
}
}
// ... 残りのパラメータは、実際のプロセスの作成呼び出しで使用するものと同じです
}'
レスポンス(200 OK)
{
"process": {
"id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
"state": "PROCESS_STATE_FINISHED",
"result": "PROCESS_RESULT_OK",
"flow": "your-sandbox-flow",
"simulated": true,
"capacities": ["PROCESS_CAPACITY_IDUNICO", "PROCESS_CAPACITY_IDAGE"],
"authenticationInfo": {
"authenticationResult": "AUTHENTICATION_RESULT_POSITIVE",
"livenessResult": "LIVENESS_RESULT_LIVE",
"idAgeResult": "ID_AGE_RESULT_POSITIVE"
},
"person": { "duiType": "DUI_TYPE_BR_CPF", "duiValue": "12345678909" }
}
}
サポートされていないシグナル
以下のシグナルは、どちらのフォーマットでもモックによってサポートされていません:
multi_accountsdata_mismatchserial_fraudstersmart_revalidation_resultpasskey_result(非推奨)
フリクションレスフロー(生体認証キャプチャなしの認証)は id_cloud_one_result フォーマットでのみサポートされています — authentication_info では動作しません。
レスポンスに関する注意事項
スコアは、本人確認結果が判 定不能な場合にのみ返されます。 score_engine_result フィールドは、authentication_result が AUTHENTICATION_RESULT_INCONCLUSIVE の場合にのみ値を反映します。authentication_result を POSITIVE または NEGATIVE としてモックし、同時に非ゼロの score_engine_result を指定した場合、送信した値に関わらず、最終的なレスポンスは score_enabled: SCORE_ENABLED_FALSE および score: 0 を返します。
これはAPIの通常の動作です — 同じルールが実際のプロセスにも適用され、モックに固有のものではありません。テストしたいシナリオがレスポンスにスコアが表示されることに依存する場合は、authentication_result: AUTHENTICATION_RESULT_INCONCLUSIVE を使用してください。
エラー
| 状況 | エラー |
|---|---|
サンドボックス外での expected_result | PERMISSION_DENIED |
id_cloud_one_result と authentication_info を同時に送信 | INVALID_ARGUMENT |
空の authentication_info: {} | INVALID_ARGUMENT |
authentication_info にフローが返すシグナルが欠落している | 検証エラー — すべてのシグナルを含めてください |
フローが認識しない id_cloud_one_result の値 | 検証エラー |
flow がモックをサポートしていない | 検証エラー |
次のステップ
モックされたプロセスを作成した後、通常どおり生体認証キャプチャを完了し、プロセスの取得を使用してモックされた結果を取得してください。