checkresult

2022-05-09 03:03

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

ZOLOZ Connect checkresult API 用于请求人脸验证的结果。该 API 符合幂等性。

结构

请求参数

字段名称

数据类型

最大长度

描述

bizId

String

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

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

transactionId

String

必填项。事务 ID，由 ZOLOZ Connect initialize API 在初始化人脸验证进程时的响应消息中返回。

响应参数

字段名称

数据类型

描述

result

Result

必填项。包含了 API 请求结果的信息，例如结果状态和错误码。

extFaceInfo

ExtFaceInfo

人脸验证的详细信息。

可选项。当 result.resultCode 值为SUCCESS或NOT_SAME_PERSON时返回该字段。

结果

结果处理逻辑

不同的请求结果，执行不同的动作。有关详细信息，请参阅以下内容：

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

场景错误码

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

API 结果码

Connect checkresult API 的结果码见下表。

结果码	结果状态	描述
SUCCESS	S	API 调用成功。
INVALID_ARGUMENT	F	关于无效参数的详细信息，请查看结果消息或相关日志。
SYSTEM_ERROR	F	其他内部错误。关于错误详情，请查看返回的结果消息和相关日志。
NOT_SAME_PERSON	F	人脸验证失败。原因可能是人脸对比分数低于阈值，或检测到欺诈/高风险行为。
UNABLE_GET_IMAGE	F	注册的图像不可用或无效。
PROCESSING	F	正在进行人脸验证。

代码示例

请求示例

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

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

响应示例

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

copy
{
    "result": {
        "resultCode": "SUCCESS",
        "resultMessage": "Success",
        "resultStatus": "S"
    },
    "extFaceInfo": {
        "aliveImage": "#ALIVE_FACE_BASE64_CONTENT#",
        "refImage": "#REFERENCE_FACE_BASE64_CONTENT#",
        "faceScore": 89.1,
        "faceAttack": false
    }
}

更多信息

ExtFaceInfo

ExtFaceInfo 数据模型中字段的说明见下表。

字段名称	数据类型	描述
aliveImage	String	采用 base64 编码的人脸自拍图像。只有当人脸验证进程正常运行时才需要为该字段赋值。
refImage	String	采用 base64 编码的人脸注册图像。只有当人脸验证进程正常运行时才需要为该字段赋值。
faceScore	Double	人脸对比分数，即将实时人脸（自拍）与注册人脸对比后的对比结果，取值范围 0-100。只有当人脸验证进程正常进行时才需要为该字段赋值。
faceAttack	Boolean	通过人脸活体检测算法判断当前的人脸自拍图像是否为假脸攻击。如果判断结果是假脸攻击，则返回 false；否则，返回True。