delete
重要说明:
- 所有请求及返回参数均严格以官网API文档为准。
- API返回结果中可能包含未在文档中定义的字段。这些字段仅供内部调试使用,不保证稳定性及兼容性,请勿在生产环境中依赖这些字段,ZOLOZ保留随时修改或删除这些字段的权利,且无需另行通知。
概览
- API URL:POST /api/v1/zoloz/applicant/delete
- API 描述:该接口用于永久删除当前商户下指定的申请人及其关联的 KYC 数据。
说明:
- 该接口执行物理删除。删除成功后,当前商户下的申请人记录,以及已归户到该申请人名下的 KYC 数据副本(包括证件、人脸数据及对应转存文件)将被永久删除,无法恢复;源 RealID transaction 数据不受影响。
- 已共享给其他商户并形成独立副本的数据不会级联删除。
- 该接口不支持幂等调用。申请人删除成功后,再次使用相同
applicantId调用时,接口将返回APPLICANT_NOT_FOUND。 - 调用前请仔细确认
applicantId和删除范围。删除操作不可逆,执行成功后无需再次调用。
请求参数
字段名称 | 数据类型 | 最大长度 | 是否必填 | 默认值 | 描述 | 示例值 |
bizId | String | 32 | 是 | - | 业务ID,业务的唯一标识,用于追踪业务。例如,商户业务相关数据库中的序列号。 说明:ZOLOZ不校验该值的唯一性,商户侧需自行保证该业务ID的唯一性。 | 2026053000012 |
applicantId | String | 50 | 是 | - | 待删除的ZOLOZ申请人ID。该申请人必须属于当前商户。 | APHK_a1b2c3d4e5f6 |
返回参数
字段名称 | 数据类型 | 必须返回 | 描述 | 示例值 |
result | 是 | API请求结果,包含结果状态、结果码和结果消息。 | { "resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success" } | |
transactionId | String | 否 | 本次调用返回的交易ID,可用于业务追踪和问题排查。 说明:仅当交易进入处理阶段后系统才会返回
| G000000005FID2020030400000000000157**** |
返回规则
处理结果 | 返回内容 |
删除成功 | 返回 |
申请人不存在 | 返回 |
删除失败 | 返回 |
删除影响
数据或行为 | 删除结果 |
当前商户名下的申请人 | 永久删除,不可恢复。 |
申请人在当前商户下关联的 KYC 数据 | 随申请人一起永久删除。 |
已共享给其他商户并形成的独立数据副本 | 不会级联删除,其他商户的数据副本不受影响。 |
删除后再次使用相同 | 申请人已不存在,相关 API 将按申请人不存在处理。 |
删除后再次调用本接口 | 返回 |
处理结果
根据请求结果执行下一步的响应动作,具体如下:
- 当
result.resultCode=SUCCESS时,表示申请人及其在当前商户下关联的 KYC 数据已删除。 - 当
result.resultCode=APPLICANT_NOT_FOUND时,表示applicantId对应的申请人不存在、不属于当前商户,或此前已被删除。 - 当
result.resultStatus=F时,表示删除失败,请根据返回的resultCode和resultMessage排查请求参数或系统错误。
API通用结果码
有关通用结果码的完整列表,请参见API通用结果码。
API特有结果码
Reusable RealID delete API的结果码见下表。
结果码 | 结果状态 | 描述 |
SUCCESS | S | 申请人及其在当前商户下关联的 KYC 数据已删除。 |
APPLICANT_NOT_FOUND | F |
|
INVALID_ARGUMENT | F | 输入参数无效。可能原因包括:缺少必填参数、字段超长等。具体错误信息请查看返回的 |
SYSTEM_ERROR | F | 系统内部错误。有关错误详情,请查看返回的 |
代码示例
请求示例
{
"bizId": "2026053000012",
"applicantId": "APHK_a1b2c3d4e5f6"
}返回示例
成功返回示例:
{
"result": {
"resultStatus": "S",
"resultCode": "SUCCESS",
"resultMessage": "Success"
},
"transactionId": "G000000005FID20200304000000000001570702"
}申请人不存在示例:
{
"result": {
"resultStatus": "F",
"resultCode": "APPLICANT_NOT_FOUND",
"resultMessage": "Applicant not found."
},
"transactionId": "G000000005FID20200304000000000001570703"
}