ZOLOZZOLOZDOCS

enroll

重要说明：

  • 所有请求及返回参数均严格以官网API文档为准。
  • API返回结果中可能包含未在文档中定义的字段。这些字段仅供内部调试使用，不保证稳定性及兼容性，请勿在生产环境中依赖这些字段，ZOLOZ保留随时修改或删除这些字段的权利，且无需另行通知。

概览

  • API URL：/api/v1/zoloz/smile/enroll
  • API 描述：该接口用于将用户预先采集的人脸图片注册到ZOLOZ系统。注册成功后，用户即可使用已注册的人脸进行身份验证。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

是

-

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

说明：ZOLOZ不校验该值的唯一性，商户侧需自行保证该业务ID的唯一性。

"2017839040588699"

twoFaInfo

String

32

是

-

两步验证信息，支持设置手机号码或通用信息。

  • 手机号码：需符合策略规定的长度，且必须为纯数字。
  • 通用信息：可由商户自定义配置，配置后不可更改。

"11111111"

userId

String

64

是

-

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

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

"123456abcd"

imageContent

String

5MB

是

-

需要注册的人脸图片，采用Base64编码格式。

"/9j/4AAQSkZJRgABAQAAlgCWAAD/4QCARXhpZgA"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

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

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

enrollResult

String

是

注册结果。

  • Success：注册成功
  • Failure：注册失败

"Success"

transactionId

String

否

本次注册生成的唯一交易ID。

说明：仅当交易进入处理阶段后系统才会返回transactionId。如果在开始处理交易之前发生错误，系统不会返回transactionId。包括但不限于以下情况：

  • 请求参数非法，例如入参格式错误或缺失必传参数。
  • 请求未能成功到达服务器，例如网络问题或网关故障。
  • 系统限流导致请求被拒绝。

"G000000001FSE2025070100000001308203****"

代码示例

请求示例

copy
{
    "bizId": "2017839040588699", 
    "twoFaInfo": "11111111", 
    "userId": "123456abcd", 
    "imageContent": "/9j/4AAQSkZJRgABAQAAlgCWAAD/4QCARXhpZgA"
}

返回示例

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "enrollResult": "Success", 
    "transactionId": "G000000001FSE2025070100000001308203****"
}