enroll

概览

  • API URL:/api/v1/zoloz/connect/enroll
  • API 描述:该接口用于注册已采集的用户人脸图片,供后续Connect进行人脸验证使用。此人脸图片可以从RealID或Face Capture的结果中获取。

请求参数

字段名称

数据类型

最大长度

是否必填

描述

示例值

bizId

String

32

业务ID,业务的唯一标识,用于追踪业务。例如,商户业务相关数据库中的序列号。

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

"2017839040588699"

userId

String

64

商户的用户ID或其他可用于识别某一用户的标识,例如手机号码、电子邮件地址等。

建议对userId字段的值进行预脱敏,例如进行哈希处理。

"123456abcd"

base64ImageContent

String

1MB

采用Base64编码的人脸图片,该图片必须为JPG格式。

"/9j/4Axxxxxxxx"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

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

{

"resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success"

}

transactionId

String

ZOLOZ服务器生成的唯一事务ID。

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

"G006600016CN20190114000000009572520355"

处理结果

根据请求结果执行下一步的响应动作,具体如下:

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

API通用结果码

有关通用结果码的完整列表,请参见API通用结果码

API特有结果码

Connect enroll API的结果码见下表。

结果码

结果状态

描述

SUCCESS

S

API调用成功。

UNABLE_GET_IMAGE

F

无法从图片中提取人脸特征。

INVALID_ARGUMENT

F

输入参数无效。关于无效参数的详细信息,请查看返回的resultMessage。

SYSTEM_ERROR

F

其他内部错误。有关错误详情,请查看返回的resultMessage。

代码示例

请求示例

商户服务端发送的请求代码示例。

copy
{
    "bizId":"2017839040588699",
    "userId":"123456abcd", 
    "base64ImageContent":"/9j/4Axxxxxxxx"
}

返回示例

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

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