unenroll

2024-04-17 12:02

概览

API URL：/api/v1/zoloz/connect/unenroll
API 描述：该接口用于删除用户在注册过程中获得的所有人脸图片和面部特征。删除数据后该用户将无法使用Connect initialize API进行核身验证，如需使用可调用Connect enroll API重新注册。

请求参数

字段名称

数据类型

最大长度

是否必填

描述

示例值

bizId

String

是

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

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

"2017839040588699"

userId

String

是

需要删除的用户ID，该用户ID来自于enroll API。

"123456abcd"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

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

{

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

}

transactionId

String

否

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

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

"G000000000FCN20240222000000044514419208"

处理结果

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

当result.resultStatus的值为S时，表示调用ZOLOZ Connect unenroll API成功，并返回唯一的事务ID。
当result.resultStatus的值为F时，表示调用ZOLOZ Connect unenroll API失败。请检查错误码获取有关该错误的更多信息，并分析导致该错误的原因。
当result.resultStatus的值为U时，表示在删除过程中遇到了一些问题，导致人脸图片或面部特征没有被完全删除，如遇该情况请联系ZOLOZ技术支持。

API通用结果码

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

API特有结果码

Connect unenroll API的结果码见下表。

结果码	结果状态	描述
SUCCESS	S	API调用成功。
DELETE_REFERENCE_SOURCE_FAILED	U	人脸图片或面部特征没有被完全删除。有关错误详情，请查看返回的resultMessage。
INVALID_ARGUMENT	F	输入参数无效。关于无效参数的详细信息，请查看返回的resultMessage。
USER_ALREADY_UNENROLLED	F	该用户的相关数据已被删除，无法再次删除。
USER_NOT_EXIST	F	用户不存在，无需删除。
SYSTEM_ERROR	F	其他内部错误。有关错误详情，请查看返回的resultMessage。

代码示例

请求示例

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

返回示例

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