checkresult

2022-05-09 03:03

入口：/api/v1/zoloz/facecapture/checkresult

ZOLOZ Face Capture checkresult API 用于请求有关人脸采集的结果。该 API 符合幂等性。

结构

请求参数

字段名称

数据类型

最大长度

描述

bizId

String

必填项。出于追踪目的的业务 ID，用来唯一标识某一业务。例如，商户业务相关数据库中的序列 ID。

说明：ZOLOZ 服务器不检查该字段的值是否唯一。因此为了更便捷地追踪业务，建议开启商户服务器，并确保业务 ID 的唯一性。

transactionId

String

必填项。事务 ID，由 initialize API 在初始化人脸采集的响应消息中返回。

响应参数

字段名称	数据类型	描述
result	Result	必填项。包含了 API 请求结果的信息，例如结果状态和错误码。
extInfo	ExtInfo	可选项。人脸采集的详细信息。当 result.resultCode 值为`SUCCESS`时返回该字段的值。

结果

结果处理逻辑

执行的操作因返回的请求结果而异。有关详细信息，请参阅以下内容：

当 result.resultCode 的值为SUCCESS时，表示调用 ZOLOZ Face Capture checkresult API 成功，并返回了人脸采集结果。
当 result.resultCode 的值非SUCCESS 时，表示调用 ZOLOZ Face Capture checkresult API 失败。请检查错误码以获取有关该错误的更多信息，并分析可能导致该错误的原因。

场景错误码

有关常见错误码的完整列表，请参见错误处理中常见错误码部分。

API 结果码

Connect checkresult API 的结果码见下表。

结果码	结果状态	描述
SUCCESS	S	API 调用成功。
PROCESSING	S	正在采集人脸图像。
INVALID_ARGUMENT	F	输入参数无效。关于无效参数的详细信息，请查看结果消息或相关日志。
UNUSABLE	F	ZOLOZ SDK 返回的元信息未通过可用性检查，表明用户无法使用人脸采集功能。
SYSTEM_ERROR	F	其他内部错误。关于错误详情，请查看返回的结果消息和相关日志。

代码示例

请求示例

以下是商家服务器发送的请求代码示例。

copy
{
    "bizId": "2017839040588699",
    "transactionId": "G006600016CN20190114000000009572520355",
}

响应示例

以下是 ZOLOZ 服务器返回的响应代码示例。

copy
{
  "extInfo": {
    "imageContent": "base64string.....",
    "faceAttack": false,
    "rect": {
      "top": 233,
      "left": 165,
      "bottom": 479,
      "right": 410
    },
    "quality": 97.61517973846627
  },
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success",
    "resultStatus": "S"
  }
}

字段名称	数据类型	描述
imageContent	string	可选项。人脸采集图像，并且是 base64 编码。
faceAttack	boolean	可选项。通过人脸活体检测算法判断当前的人脸采集图像是否属于假脸攻击。如果判断结果不是假脸攻击，则返回`false`；否则，返回`true`。
rect	Map	可选项。人脸图像的坐标数据，例如： {"top": 233, "left": 165, "bottom": 479, "right": 410}
quality	double	可选项。图像质量的分数。该字段的取值范围是 0-100。