概要

API URL: /api/v1/zoloz/facecompare/asynccheckresult
API の説明: ZOLOZ 顔照合 asynccheckresult API は、顔照合結果を非同期的に取得するために使用されます。この API を呼び出すときは、asynccompare API から返されたトランザクション ID を渡す必要があります。

リクエスト

フィールド仕様

名前	タイプ	最大長	必須	説明	サンプル値
transactionId	文字列	64B	true	asynccompare API から返されたトランザクション ID。	"G000000005FID2020030400000000000157****"

リクエストサンプル

POST /api/v1/zoloz/facecompare/asynccheckresult HTTP/1.1Content-Type: application/json; charset=UTF-8Client-Id: 5X67656YXXXXXX
Request-Time: 2024-01-04T12:08:56+05:30Signature: algorithm=RSA256, signature=xxxxxxxxxxxx

{
  "transactionId": "G000000005FID2020030400000000000157****"}

レスポンス

フィールド仕様

名前	タイプ	必須	値の範囲	説明	サンプル値
result.resultCode	文字列	true		結果コード	"SUCCESS"
result.resultStatus	文字列	true		結果ステータス	"S"
result.resultMessage	文字列	true		結果メッセージ	"success"
transactionId	文字列	true		トランザクション ID 注: システムは、トランザクションが処理段階に入った後にのみ `transactionId` を返します。トランザクションの処理が開始される前にエラーが発生した場合、システムは `transactionId` を返しません。これには、以下の状況が含まれますが、これらに限定されません。無効なリクエストパラメータ (入力形式が正しくない、必須パラメータが不足しているなど)。ネットワークの問題やゲートウェイの障害などにより、リクエストがサーバーに正常に到達できない。システムのレート制限により、リクエストが拒否される。	"G000000005FID20200304000000000001570702"
face1ImageQualityResult	文字列	true		顔 1 の画質結果。 `PASS`: 適格 `FAIL`: 不適格注: `face1ImageQualityResult` または `face2ImageQualityResult` の値が `FAIL` の場合、 `samePerson` は false を返します。	"PASS"
face2ImageQualityResult	文字列	true		顔 2 の画質結果。 `PASS`: 適格 `FAIL`: 不適格注: `face1ImageQualityResult` または `face2ImageQualityResult` の値が `FAIL` の場合、 `samePerson` は false を返します。	"PASS"
score	double	true	(0.0, 100.0)	顔照合スコア	88.2
samePerson	boolean	true	true, false	2 つの顔がアルゴリズムに基づいて同一人物かどうか	true

結果

名前	タイプ	必須	値の範囲	説明	サンプル値
resultCode	文字列	true		結果コード	"SUCCESS"
resultStatus	文字列	true	"S": 成功 "F": 失敗	結果ステータス	"S"
resultMessage	文字列	true		結果の説明	"success"

"resultCode" のビジネスレベルでの値の範囲:

resultCode	説明
INVALID_ARGUMENT	`transactionId` が null または空の文字列です。
PROCESSING	処理中です。
UNABLE_GET_IMAGE	`NO_FACE`: アルゴリズムが画像またはビデオで顔を検出しません。 `IMAGE_CHECK_FAILED`: 画像が空であるか、画像形式の事前チェックがサポートされていないか、画像が大きすぎます (10 MB より大きい)。 `FACE_IMAGE_VIDEO_TYPE_NOT_SUPPORTED`: 実行中に、アルゴリズムがサポートされていない画像形式を検出しました。
SUCCESS	face1 と face2 が同一人物を示しているかどうかに関係なく、比較結果が正常に返されます。
SYSTEM_ERROR	その他の内部エラー。

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8Response-Time: 2024-01-19T21:56:15-0800Signature: algorithm=RSA256, signature=xxxxxxxxxxxxxxxxxx

{
  "transactionId": "G000000005FID2020030400000000000157****",
  "face1ImageQualityResult":"PASS",
  "face2ImageQualityResult":"PASS",
  "score": 88.2,
  "samePerson": true,
  "result": {
    "resultCode":"SUCCESS",
    "resultStatus":"S",
    "resultMessage":"Success"  }
}