The ZOLOZ Real ID initialize API is used to initialize the identity proofing process in ZOLOZ. A unique transaction ID is generated for the identity proofing process and used in all the subsequent interactions with the ZOLOZ server. This API is not idempotent.
Required. 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.
Required. The meta information about the SDK and the user's device.
When the App SDK mode is used, its value comes from the ZOLOZ SDK in JSON string format, for example:
Note: Do not modify the returned value as it only needs to be passed through directly.
When H5 mode is used, simply set the value as
Required. Specifies the type of the identity proofing flow. The following values are supported:
Required. Type of document.
Required. Merchant user ID, or other identifiers that can be used to identify a specific user.
Optional. Specifies the business scene for data analysis purposes. If you want to distinguish the data performance of different scenes, it is recommended to set the sceneCode field to different values according to your business purposes; for example, registration, withdraw, topUp, transfer, changePassword.
Optional. Specifies the service level for spoofing checks and face liveness detection. The following values are supported:
Optional. Specifies the operation mode where the identity proofing process runs. The following values are supported:
Optional. Specifies the document page numbers to scan and upload, separated by commas. E.g. "1" (scan the first page), "1,2" (scan the first and second page)
Optional. Specifies the configuration settings for the embedded H5 page. For more information, see pageConfig.
Optional. Specifies the configuration settings for H5 Real ID flow. Set this field when the H5 mode is specified with the flowType filed as
Optional. Specifies finer controls for the Real ID product. For more information, see productConfig.
Optional. Specifies whether expired documents are allowed. Only used for the docType 00000001003. The following values are supported:
Note: Invalid values will fall back to the default option and pause the Real ID process when an expired document is detected.
Required. The API request result, which contains information about the result of the API request, such as status and error codes.
Optional. A unique transaction ID that is generated by the ZOLOZ server for the identity proofing process. This ID will be used as an input parameter for the Real ID checkresult API request.
Note: when an error occurs during the process, for example, an invalid argument, no transaction ID will be returned.
Optional. The client configuration information, including parameters about the SDK connection and behavior. The value of this field is specified only when the result.resultStatus field is
Result process logic
For different request results, different actions will be performed. See the following for details:
- If the value of the result.resultStatus is
S, the ZOLOZ Real ID initialize API is invoked successfully and a unique transaction ID is returned.
- If the value of the result.resultStatus is
F, the invocation of the ZOLOZ Real ID initialize API fails. Check the error code and its message for more information on the possible reasons why.
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 following table shows the possible error codes that are specific for the Real ID initialize API.
The API call is successful.
High risks are detected. The user account is strategically cooled down by the risk engine.
The user account is blacklisted by the risk engine.
The device type is not supported.
The operating system of the device is not supported.
The version of the ZOLOZ SDK is not supported.
Input parameters are invalid. For more information about which parameter is invalid, check the result message or the related log.
Other internal errors. For more information about the error details, check the result message that is returned and the related log.
For different integration modes, the request structures are slightly different. When the identity proofing process is initiated in the H5 mode, additionally, an object called h5ModeConfig must be specified. Refer to the following two request samples for more detailed information.
Native RealId Request Sample
The following sample shows what a request looks like if the identity proofing process is initiated in the App SDK mode.
H5 RealId Request Sample
The following sample shows what a request looks like if the identity proofing process is initiated in the H5 mode.
The following sample shows what a response returned from the ZOLOZ server looks like.
The following table shows the fields that can be specified in the pageConfig data model.
Optional. Specifies the URL to the face guide page, which is an H5 prompt page that can be customized to guide users during face scanning. For example, http://url-to-face-guide-page.html.
The following table shows the fields that can be specified in the h5ModeConfig data model.
Optional. An identifier that is used to recover the customer's context. You can set this field to any String value. The value is then passed as a parameter when the ZOLOZ SDK calls back to the merchant's application. If the value is not set, the value of the transactionId field is used instead.
Required. Specifies the callback URL where the browser is redirected when the whole identity proofing process is completed.
Required. Specifies the callback URL where the browser is redirected when the process is interrupted.
Optional. Language of the web page, currently supports: en (English) / zh-CN (Simplified Chinese) / zh-HK (Traditional Chinese) / jp (Japanese) / th (Thai) / es (Español) / pt (Portuguese) / fr (French) / id (Indonesian) / de (German) / kr (Korean).
Optional. If the Web Page needs to be open in Iframe, this parameter should be set as
Optional. Custom UI configurations in the JSON string format. Only supports
The following table shows the fields that can be specified in the productConfig data model.
Optional. Specify whether to crop the background of the captured DOC image. Valid values include:
Optional. Specify whether to crop the face area of the captured FACE image. Valid values include:
Optional. Specify whether to perform landmark checks within a DOC spoofing check. Landmark checks are only applicable for selected documents. E.g. (MyKad)
Optional. Specify whether to perform hologram checks within a DOC spoofing check. Hologram checks are only applicable for selected documents. E.g. (MyKad)
Optional. Specify whether to perform information checks within a DOC spoofing check. information checks are only applicable for selected documents.
Optional. Specify whether to perform a precise tamper check. Precise tamper checks are only applicable for selected documents. The following values are supported:
Optional. This parameter refers to methods for taking ID photos. The values are as follows:
The following parameters take precedence over
Optional. This parameter refers to document anti-spoofing levels, defined as follows:
Optional. Specifies the liveness level for face liveness detection check. The following values are supported:
Optional. Specifies the anti-injection level for injection attack detection. Injection attack detection can effectively resist injection attacks using deepfakes i.e. face-swapping pictures or videos. The following values are supported:
Note: Enabling injection attack detection will slightly increase false rejection rate and runtime. Please contact ZOLOZ technical support team before turning on this function.
Optional. User actions to be detected. For better user experience, it is not recommended to use two or more actions. The following values are supported:
Optional. Specifies whether user actions specified in
Optional. This parameter refers to capturing other frame pictures, defined as follows:
Optional. This parameter refers to multi-dimensional risk control rule verification in RealID. It is used to intercept suspicious transactions. The values are as follows:
Optional. The default threshold is
Any integer larger than 0 is supported.
22 November, 2023
Added new fields for the productConfig parameter.
22 May, 2022
A new parameter, productConfig, is added in the request.
9 June, 2020
A new parameter, pageConfig, is added in the request.
27 December, 2019
20 December, 2019
The following two request parameters are added:
06 December, 2019