initialize

2022-12-23 10:05

POST /api/v1/zoloz/facecapture/initialize

The ZOLOZ Face Capture initialize API is used to initialize the face capture process in ZOLOZ. A unique transaction ID is generated for the process and used in all the subsequent interactions with the ZOLOZ server. This API is not idempotent.

Structure

Request parameters

Field name	Data type	Max length	Description
bizId	String	32	Required. A unique business ID for tracing purpose. For example，the sequence ID from the merchant's business-related database. Note: The ZOLOZ server does not perform uniqueness check 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.
metaInfo	String	512	Required. The meta information about the SDK and the user's device. The value of this field is returned from the ZOLOZ SDK in the JSON string format, for example: `"{\"apdidToken\":\"69b74bfe-bf7f-4d3b-ac59-907ee09e7955\",\"appName\":\"com.zoloz.atomic.client\",\"appVersion\":\"1.0.9\",\"bioMetaInfo\":\"3.46.0:2916352,0\",\"deviceModel\":\"MI 6\",\"deviceType\":\"android\",\"osVersion\":\"9\",\"zimVer\":\"1.0.0\"}"`. Note: Do not modify the returned value as it only needs to be passed through directly. Set to "MOB_H5" if it is in H5 mode.
userId	String	32	Optional. Merchant user ID, or other identifiers that can be used to identify a specific user, for example, mobile phone number, email address and so on. It is strongly recommended to pre-desensitize the value of the userId field, for example, by hashing the value.
h5ModeConfig	Object		Optional. Specifies the configuration settings for H5 mode. For more information，refer below to the h5ModeConfig section.
serviceLevel	String	32	Optional. Specifies the service level for face liveness check and user action detection. The following values are supported: FACECAPTURE0001: If this value is set, the ZOLOZ server performs basic liveness check, and with no detection method used. FACECAPTURE0002: If this value is set, the ZOLOZ server performs middle level liveness check and with the blink detection method used. FACECAPTURE0003: If this value is set, the ZOLOZ server performs high level liveness check with any 2 of the multi-action detection methods randomly. multi-action detection methods are: blink, mouth open, head up, head down, head shakes(left), head shakes(right) FACECAPTURE0005: If this value is set, the ZOLOZ server performs full liveness check and with the blink detection method used, this service level provides the ability to capture eye closed images for native SDK. FACECAPTURE0010: If this value is set, the ZOLOZ server performs full liveness check and with the blink detection method used, this service level provides the ability to capture eye closed images for web SDK.
operationMode	String	32	Optional. Specifies the operation mode where the identity proofing process runs. The following values are supported: `CLOSED`: All the algorithms and risk control rules are not applied. You can use this operation mode in the test phase so that the algorithms and risk controls rules do not affect the test process. `STANDARD`: A standard recommended level is applied. `LOOSE`: A relatively looser level is applied. You can use this operation mode in low-risk scenarios. `STRICT`: A relatively stricter level is applied. You can use this operation mode in high-risk scenarios.

Response parameters

Field name	Data type	Description
result	Result	Required. The API request result, which contains information about the result of the API request, such as status and error codes.
transactionId	String	Optional. A unique transaction ID that is generated by the ZOLOZ server for the Face Capture process. This ID will be used as an input parameter for the Face Capture checkresult API request. Note: when an error occurs during the process, for example, invalid argument, no transaction ID is returned.
clientCfg	String	Optional. The client configuration information, including parameters about SDK connection and behavior. The value of this field is specified only when the result.resultStatus field is `"S"`.

Result

Result process logic

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

If the value of the result.resultStatus is S , the ZOLOZ Face Capture 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 Face Capture initialize API fails. Check the error code and message for more information about the possible reasons. Error codes

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 Connect initialize API.

resultCode	resultStatus	Description
SUCCESS	S	The API call is successful.
HIGH_RISK	F	High risks are detected. The user account is strategically cooled down by the risk engine.
DEVICE_NOT_SUPPORT	F	The device type is not supported.
OS_NOT_SUPPORT	F	The operating system of the device is not supported.
SDKVERSION_NOT_SUPPORT	F	The version of the ZOLOZ SDK is not supported.
INVALID_ARGUMENT	F	Input parameters are invalid. For more information about which parameter is invalid, check the result message or the related log.
SYSTEM_ERROR	F	Other internal errors. For more information about the error details, check the result message that is returned and the related log.

Sample

Request sample

For different integration modes, the request structures are a little different. When the face capture process is initiated in the H5 mode, additionally, an object called h5ModeConfig must be specified. Refer to the following two request samples for the detailed information.

Native RealId Request Sample

The following sample shows what a request that the merchant server sends looks like.

copy
{
    "bizId":"test-bizId",
    "metaInfo": "{\"apdidToken\":\"69b74bfe-bf7f-4d3b-ac59-907ee09e7955\",\"appName\":\"com.zoloz.atomic.client\",\"appVersion\":\"1.0.9\",\"bioMetaInfo\":\"3.46.0:2916352,0\",\"deviceModel\":\"MI 6\",\"deviceType\":\"android\",\"osVersion\":\"9\",\"zimVer\":\"1.0.0\"}",
    "userId": "not mandatory"
}

H5 RealId Request Sample

The following sample shows what a request looks like if the face capture process is initiated in the H5 mode.

copy
{
    "bizId":"dummy_bizid_1626180988600",
    "metaInfo":"MOB_H5",
    "userId":"dummy_userid_1626180988600",
    "h5ModeConfig":{
        "completeCallbackUrl":"http://xxx/result.html",
        "interruptCallbackUrl":"http://xxx/result.html"
    }
}

Response Sample

The following sample shows what a response that the ZOLOZ server returns looks like.

copy
{
    "result": {
        "resultStatus": "S",
        "resultCode": "SUCCESS",
        "resultMessage": "Success"
    },
    "transactionId":"G006600016CN20190114000000009572520355", 
    "clientCfg": "……"   
}

More information

h5ModeConfig

The following table shows the fields that can be specified in the h5ModeConfig Object.

Field name	Data type	Max length	Description
state	String	128	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.
completeCallbackUrl	String	128	Required. Specifies the callback URL where the browser is redicted when the whole identity proofing process is completed.
interruptCallbackUrl	String	128	Required. Specifies the callback URL where the browser is redirected when the process is interrupted.
isIframe	String	1	Optional. If the Web Page need to be open in Iframe, this param should be set as Y. Supported Value: Y / N
locale	String	16	Optional. Language of the web page, only support: en/ id now
uiCfg	String	256	Optional. Custom UI configurations in the JSON string format. Only support `isDesktop`, For example:`"{\"isDesktop\":\"Y\"}"`.