update

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/update
API Description: This API is used to update the email address or phone number of a specified applicant under the current merchant.

Notes:

This API adopts non-null PATCH semantics. Only fields with non-null values in the request are updated. Fields that are not passed or have null values remain unchanged.
At least one of email or phone must be provided with a non-null value. If both fields are not provided or both are null, the API returns INVALID_ARGUMENT.
This API supports idempotent calls. When called multiple times with the same parameters, the applicant information remains consistent with the specified values in the request.

Request Parameters

Field Name	Data Type	Max Length	Required	Default Value	Description	Example
bizId	String	32	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.	2026060200001
applicantId	String	50	Yes	-	The ZOLOZ applicant ID to be updated. The applicant must belong to the current merchant.	APHK_a1b2c3d4e5f6
email	String	255	No	null	The new email address for the user. If provided, it must conform to standard email format. If not passed or set to null, the original value remains unchanged.	newuser@example.com
phone	String	50	No	null	The new phone number for the user. If not passed or set to null, the original value remains unchanged.	+85298765432

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
Update Successful	Returns `result` with `resultCode=SUCCESS` and `transactionId`.
Applicant Not Found	Returns `result` with `resultCode=APPLICANT_NOT_FOUND` and `transactionId`.
Update Failed	Returns `result` and `transactionId`, with the failure reason described by `resultCode` and `resultMessage`.

Field Update Rules

Request Method	`email` Processing Result	`phone` Processing Result
Both non-null `email` and `phone` provided	Updated to new value	Updated to new value
Only non-null `email` provided	Updated to new value	Remains unchanged
Only non-null `phone` provided	Remains unchanged	Updated to new value
Field not passed or set to null	Remains unchanged	Remains unchanged
Neither `email` nor `phone` provided, or both null	Returns `INVALID_ARGUMENT`	Returns `INVALID_ARGUMENT`

Result

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

When result.resultCode = SUCCESS: The applicant information was updated successfully.
When result.resultCode = APPLICANT_NOT_FOUND: The applicant corresponding to the provided applicantId does not exist or does not belong to the current merchant.
When result.resultStatus = F: The update 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 update API are listed in the table below.

resultCode	resultStatus	Description
SUCCESS	S	The applicant information was updated successfully.
APPLICANT_NOT_FOUND	F	The applicant corresponding to the provided `applicantId` does not exist or does not belong to the current merchant.
INVALID_ARGUMENT	F	Invalid input parameters. Possible causes include missing required parameters, field length exceeded, invalid email format, or failure to provide a non-null value for either `email` or `phone`. For detailed error information, check the returned `resultMessage`.
SYSTEM_ERROR	F	Internal system error. For error details, check the returned `resultMessage`.

Sample

Request Sample

Update Both Email and Phone:

copy
{
    "bizId": "2026060200001", 
    "applicantId": "APHK_a1b2c3d4e5f6", 
    "email": "newuser@example.com", 
    "phone": "+85298765432"
}

Update Phone Only:

The following request updates only the phone field. Since email is not passed, the applicant's email address remains unchanged.

copy
{
    "bizId": "2026060200002", 
    "applicantId": "APHK_a1b2c3d4e5f6", 
    "phone": "+85291234567"
}

Response Sample

Successful Response

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

Failure Response

copy
{
    "result": {
        "resultStatus": "F", 
        "resultCode": "INVALID_ARGUMENT", 
        "resultMessage": "At least one of email or phone must be provided."
    }, 
    "transactionId": "G000000005FID20200304000000000001570703"
}