delete

2026-08-26 08:47

Important Notice:

All request and response parameters are strictly subject to the official API documentation.
The API response may contain fields not defined in the documentation. These fields are for internal debugging purposes only and are not guaranteed to be stable or compatible. Do not rely on these fields in production environments. ZOLOZ reserves the right to modify or remove these fields at any time without prior notice.

Overview

API URL: POST /api/v1/zoloz/applicant/delete
API Description: This API is used to permanently delete the specified applicant and its associated KYC data under the current merchant.

Notes:

This API performs a physical deletion. After successful deletion, the applicant record under the current merchant, as well as the KYC data copies attributed to the applicant (including document data, face data, and corresponding stored files), will be permanently deleted and cannot be recovered. The source RealID transaction data is not affected.
Data that has already been shared with other merchants and formed independent copies will not be cascaded for deletion.
This API does not support idempotent calls. After an applicant is successfully deleted, calling this API again with the same applicantId will return APPLICANT_NOT_FOUND.
Before calling this API, carefully confirm the applicantId and the scope of deletion. The deletion operation is irreversible. No further action is required after successful execution.

Request Parameters

Field Name

Data Type

Max Length

Required

Default Value

Description

Example

bizId

String

Yes

A unique business ID for tracing purposes. For example, the sequence ID from the merchant's business-related database.

Note: The ZOLOZ server does not perform uniqueness checks on the value of this field. For better tracking, it is strongly recommended to enable the merchant server to guarantee the uniqueness of the business ID.

2026053000012

applicantId

String

Yes

The ZOLOZ applicant ID to be deleted. The applicant must belong to the current merchant.

APHK_a1b2c3d4e5f6

Response Parameters

Field Name

Data Type

Always Returned

Description

Example

result

Result

Yes

The API request result, which contains the result status, result code, and result message.

{

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

}

transactionId

String

The transaction ID for this API call, which can be used for business tracking and troubleshooting.

Note: The system will only return the transactionId after the transaction enters the processing stage. If an error occurs before the transaction begins processing, the system will not return a transactionId. This includes, but is not limited to, the following situations:

Invalid request parameters, such as incorrect input format or missing required parameters.
The request fails to reach the server successfully, such as due to network issues or gateway failures.
The request is denied due to system rate limiting.

G000000005FID2020030400000000000157****

Response Rules

Processing Result	Returned Content
Deletion Successful	Returns `result` with `resultCode=SUCCESS` and `transactionId`.
Applicant Not Found	Returns `result` with `resultCode=APPLICANT_NOT_FOUND` and `transactionId`.
Deletion Failed	Returns `result` and `transactionId`, with the failure reason described by `resultCode` and `resultMessage`.

Deletion Impact

Data or Behavior	Deletion Result
Applicant under the current merchant	Permanently deleted and cannot be recovered.
KYC data associated with the applicant under the current merchant	Permanently deleted along with the applicant.
Independent data copies already shared with other merchants	Not cascaded for deletion. Other merchants' data copies are not affected.
Query or operation with the same `applicantId` after deletion	The applicant no longer exists. Relevant APIs will handle it as `APPLICANT_NOT_FOUND`.
Calling this API again after deletion	Returns `APPLICANT_NOT_FOUND`.

Result

For different request results, different actions will be performed. See the following for details:

When result.resultCode = SUCCESS: The applicant and its associated KYC data under the current merchant have been deleted.
When result.resultCode = APPLICANT_NOT_FOUND: The applicant corresponding to the provided applicantId does not exist, does not belong to the current merchant, or has already been deleted.
When result.resultStatus = F: The deletion failed. Check the returned resultCode and resultMessage to identify issues with request parameters or system errors.

Common error codes

For the full list of common error codes, see the Common error codes section in the Error handling topic.

API-specific error codes

The error codes specific to the Reusable RealID delete API are listed in the table below.

resultCode	resultStatus	Description
SUCCESS	S	The applicant and its associated KYC data under the current merchant have been deleted.
APPLICANT_NOT_FOUND	F	The applicant corresponding to the provided `applicantId` does not exist, does not belong to the current merchant, or has already been deleted.
INVALID_ARGUMENT	F	Invalid input parameters. Possible causes include missing required parameters, field length exceeded, etc. For detailed error information, check the returned `resultMessage`.
SYSTEM_ERROR	F	Internal system error. For error details, check the returned `resultMessage`.

Sample

Request Sample

copy
{
    "bizId": "2026053000012", 
    "applicantId": "APHK_a1b2c3d4e5f6"
}

Response Sample

Successful Response

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

Applicant Not Found Response

copy
{
    "result": {
        "resultStatus": "F", 
        "resultCode": "APPLICANT_NOT_FOUND", 
        "resultMessage": "Applicant not found."
    }, 
    "transactionId": "G000000005FID20200304000000000001570703"
}