enroll

2022-05-09 03:03

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

ZOLOZ Connect enroll API 用于注册预先采集的用户面部图像，供后续 Connect Face Verify 使用。此人脸图像可以从 Real ID 或人脸采集结果中获取。

结构

请求参数

字段名称	数据类型	最大长度	描述
bizId	String	32	必填项。出于追踪目的的业务 ID，用来唯一标识某一业务。例如，商户业务相关数据库中的序列号。说明：ZOLOZ 服务器不检查该字段的值是否唯一。因此为了更便捷地追踪业务，建议开启商户服务器，并确保业务 ID 的唯一性。
userId	String	64	必填项。商家用户 ID，或其他可用于识别某一用户的标识，例如手机号码、电子邮件地址等。建议对 userId 字段的值进行预脱敏，如进行哈希处理。
base64ImageContent	String	1MB	必填项。以 Base64 编码的人脸图像，该图片必须是 JPG 格式。

响应参数

字段名称

数据类型

描述

result

Result

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

transactionId

String

可选项。由 ZOLOZ 服务器生成的唯一的事务 ID。

说明：当交互过程中出现错误时，例如参数无效，则不返回事务 ID。

结果

结果处理逻辑

根据请求结果执行下一步的响应动作，如下：

当 result.resultStatus 的值为 S时，表示调用 ZOLOZ Connect enroll API 成功，并返回唯一的事务 ID。
当 result.resultStatus 的值为 F时，表示调用 ZOLOZ Connect enroll API 失败。请检查错误码以获取有关该错误的更多信息，并分析可能导致该错误的原因。

通用错误码

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

API 结果码

Connect enroll API 的结果码见下表。

结果码	结果状态	描述
SUCCESS	S	API 调用成功。
UNABLE_GET_IMAGE	F	无法从图像中提取人脸特征。
INVALID_ARGUMENT	F	参数无效。关于无效参数的详细信息，请查看结果消息或相关日志。
SYSTEM_ERROR	F	其他内部错误。关于错误详情，请查看返回的结果消息和相关日志。

样例

请求示例

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

copy
{
    "bizId":"2017839040588699",
    "userId":"merchant side user id", 
    "base64ImageContent":"xxxxxxxxxxxxxxxxx"
}

响应示例

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

copy
{
    "transactionId": "G006600016CN20190114000000009572520355",
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "Success"
    }
}