POST /api/v1/zoloz/connect/checkresult
ZOLOZ Connect checkresult API は、顔認証処理結果に関する結果をリクエストするために使用されます。この API はべき等です。
構造
リクエストパラメーター
フィールド名 | データ型 | 最大長 | 説明 |
bizId | String | 32 | 必須。追跡目的のための一意のビジネス ID。たとえば、加盟店のビジネス関連データベースからのシーケンス ID。 注：ZOLOZ サーバーは、このフィールドの値の一意性チェックを実行しません。追跡を改善するために、加盟店サーバーでビジネス ID の一意性を保証することを強くお勧めします。 |
transactionId | String | 64 | 必須。initialize API のレスポンスで返される一意のトランザクション ID。 |
レスポンスパラメーター
フィールド名 | データ型 | 説明 |
result | 必須。API リクエストの結果。ステータスやエラーコードなど、API リクエストの結果に関する情報が含まれます。 | |
connectResult | String | 必須。Connect プロセスの結果。各トランザクションの実際の結果を Success/Failure/VoidTimeout/InProcess の形式で示します。
|
extFaceInfo | ExtFaceInfo | 顔認証の詳細情報。詳細は、以下の表を参照してください。 オプション。顔認証に関する詳細情報。このフィールドは、 フィールドの値が または に設定されている場合にのみ使用できます。result.resultCodeフィールドが設定されています成功 または 同一人物ではない。 |
結果
結果処理ロジック
リクエスト結果が異なる場合は、異なるアクションを実行する必要があります。詳細は以下を参照してください。
の値が または の場合、ZOLOZ Connect checkresult API が正常に呼び出され、顔認証に関する結果が返されます。result.resultCodeです 成功 または 同一人物ではない、ZOLOZ Connect checkresultAPI が正常に呼び出され、顔認証の結果が返されます。
それ以外の場合、ZOLOZ Connect checkresult API の呼び出しは失敗します。考えられる理由の詳細については、エラーコードとメッセージを確認してください。
一般的なエラーコード
一般的なエラーコードの全リストについては、一般的なエラーコード セクションの エラー処理 トピックを参照してください。
API 固有のエラーコード
次の表は、Connect checkresult API に固有の考えられるエラーコードを示しています。
resultCode | resultSatus | 説明 |
SUCCESS | S | API 呼び出しは成功しました。 |
INVALID_ARGUMENT | F | 入力パラメーターが無効です。どのパラメーターが無効かの詳細については、結果メッセージまたは関連ログを確認してください。 |
SYSTEM_ERROR | F | その他の内部エラー。エラーの詳細については、結果メッセージまたは関連ログを確認してください。 |
NOT_SAME_PERSON | F | 顔認証に失敗しました。考えられる理由には、次のものがあります。
|
UNABLE_GET_IMAGE | F | 登録された画像が使用できないか、無効です。 |
PROCESSING | F | 顔認証はまだ処理中です。 |
サンプル
リクエストサンプル
次のサンプルは、加盟店サーバーが送信するリクエストの例を示しています。
コピー
{
"bizId": "2017839040588699",
"transactionId": "G006600016CN20190114000000009572520355",
}レスポンスサンプル
次のサンプルは、ZOLOZ サーバーが返すレスポンスの例を示しています。
{
"result": {
"resultCode": "SUCCESS",
"resultMessage": "Success",
"resultStatus": "S"
},
"connectResult":"Success",
"extFaceInfo": {
"aliveImage": "#ALIVE_FACE_BASE64_CONTENT#",
"refImage": "#REFERENCE_FACE_BASE64_CONTENT#",
"faceScore": 89.1,
"faceAttack": false,
"deeperResult":"Success",
"deeperResultDescription":""
}
}詳細情報
ExtFaceInfo
次の表は、 データモデルで指定できるフィールドを示しています。ExtFaceInfo データモデル。
フィールド名 | データ型 | 説明 |
aliveImage | String | 顔のセルフィー画像。base64 でエンコードされています。このフィールドは、顔認証プロセスが正常に実行された場合にのみ指定されます。 |
refImage | String | 登録された顔画像。base64 でエンコードされています。このフィールドは、顔認証プロセスが正常に実行された場合にのみ指定されます。 |
faceScore | Double | ライブフェイス (セルフィー) と登録された顔の比較結果を示すスコアを指定します。顔認証プロセスが正常に実行された場合は必須です。このフィールドの値は 0 ～ 100 の範囲です。 |
faceAttack | ブール値 | 顔認証チェックアルゴリズムを使用して、顔のセルフィー画像が偽の顔攻撃として検出されたかどうかを指定します。画像が偽の顔攻撃でない場合、 の値が返されます。それ以外の場合、 の値が返されます。 |
deeperResult | String | オプション。Deeper 顔検出結果を返します。次の値が返されます。
|
deeperResultDescription | String | オプション。 が を返した場合の、Deeper 顔検出結果の詳細な説明を指定します。 |