unenroll

重要说明:

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

概览

  • API URL:/api/v1/zoloz/smile/unenroll
  • API 描述:该接口用于删除用户已注册的生物特征信息。删除成功后,用户将无法使用已删除的生物特征进行身份验证。

请求参数

字段名称

数据类型

最大长度

是否必填

默认值

描述

示例值

bizId

String

32

-

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

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

"2017839040588699"

userId

String

64

-

待删除的用户ID。用于指定需要删除注册信息的用户,该值需与注册时使用的userId一致。

"123456abcd"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

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

{

"resultStatus": "S",

"resultCode": "SUCCESS",

"resultMessage": "Success"

}

transactionId

String

本次删除返回的交易ID。

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

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

"G000000001FSE2025052300000001218988****"

unEnrollResult

String

删除结果。

  • Success:删除成功
  • Failure:删除失败

"Success"

代码示例

请求示例

copy
{
    "bizId": "2017839040588699", 
    "userId": "123456abcd"
}

返回示例

copy
{
    "result": {
        "resultStatus": "S", 
        "resultCode": "SUCCESS", 
        "resultMessage": "Success"
    }, 
    "transactionId": "G000000001FSE2025052300000001218988****", 
    "unEnrollResult": "Success"
}