asynccheckresult

概览

  • API URL:/api/v1/zoloz/facecompare/asynccheckresult
  • API 描述:该接口用于异步获取人脸比对结果,调用时需传入asynccompare API返回的事务ID。

请求参数

字段名称

数据类型

最大长度

是否必填

描述

示例值

transactionId

String

64B

asynccompare API返回的事务ID。

"G000000005FID2020030400000000000157****"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

API请求结果,包含结果状态、结果码和结果消息。

{

"resultCode": "SUCCESS",

"resultStatus": "S",

"resultMessage": "Success"

}

transactionId

String

事务ID。

"G000000005FID2020030400000000000157****"

face1ImageQualityResult

String

人脸1的图片质量结果。

  • PASS:合格
  • FAIL:不合格

说明:如果face1ImageQualityResultface2ImageQualityResult中任意一个参数的结果为FAIL,则samePerson将返回false

"PASS"

face2ImageQualityResult

String

人脸2的图片质量结果。

  • PASS:合格
  • FAIL:不合格

说明:如果face1ImageQualityResultface2ImageQualityResult中任意一个参数的结果为FAIL,则samePerson将返回false

"PASS"

score

Double

人脸比对分数,取值范围0-100。

88.2

samePerson

Boolean

人脸比对结果,通过算法判断两张人脸是否为同一人。

  • true:同一人。
  • false:不是同一人。

true

Result字段说明

字段名称

数据类型

必须返回

描述

示例值

resultCode

String

结果码。

  • INVALID_ARGUMENT:transactionId为null或空字符串。
  • PROCESSING:正在处理中。
  • UNABLE_GET_IMAGE。
    • NO_FACE:算法在图片或视频中未检测到人脸。
    • IMAGE_CHECK_FAILED:图片为空、调用算法前校验出图片格式不正确,或图片大小超过10MB。
    • FACE_IMAGE_VIDEO_TYPE_NOT_SUPPORTED:算法在执行过程中检测到图片格式不正确。
  • SUCCESS:无论两张人脸是否为同一人,都将成功返回比对结果。
  • SYSTEM_ERROR:其他内部错误。

"SUCCESS"

resultStatus

String

结果状态。

"S"

resultMessage

String

结果信息。

"Success"

代码示例

请求示例

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

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

返回示例

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

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