ZOLOZZOLOZDOCS

query enroll

概览

  • API URL：/api/v1/zoloz/connect/queryEnrollStatus
  • API 描述：该接口用于查询用户人脸的注册状态。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

是

-

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

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

"201783904058****"

userId

String

64

是

-

商户的用户ID，需要与注册用户人脸图片时传入的用户ID保持一致。

"123456abcd"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

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

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

Result字段说明

字段名称

数据类型

必须返回

描述

示例值

resultStatus

String

是

结果状态。

  • S：成功
  • F：失败

"S"

resultCode

String

是

结果码。

  • SUCCESS：用户人脸注册成功。
  • NOT_ENROLLED：该用户的人脸尚未注册。
  • INVALID_ARGUMENT：输入参数无效。
  • SYSTEM_ERROR：其他内部错误。

"SUCCESS"

resultMessage

String

是

结果描述。

"Success"

代码示例

请求示例

copy
{
    "bizId": "201783904058****", 
    "userId": "123456abcd"
}

返回示例

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