Documentation

Frontend(H5)

How To Integrate

1. Open URL in WebView

After calling the Generate URL API, there will be a url in the response body, and the App needs to open the URL in WebView.

2. Give Camera Permission

Refer to Camera Permission (H5)


Iframe Integration Guide

Refer to Iframe Integration (H5)

Error handling

When an exception occurs blocking the process on the frontend, the frontend will be redirected to the failReturnUrl, carrying the errorCode=XXX, where the errorCode is one of the following enumerated values.

errorCode

Description

NOT_SUPPORT

[Frontend Failed] Not supported due to compatibility issues.

CAMERA_ISSUE

[Frontend Failed] Camera issue error.

LIVENESS_ATTACK

[Backend Failed] The liveness detection result < 50.0.

When ignoreFailWhenJump set to true, will jump to returnUrl instead.

SIMILARITY_FAILED

[Backend Failed] The faceSimilarityScore < 70.0.
When ignoreFailWhenJump set to true, will jump to returnUrl instead.

UNABLE_GET_IMAGE

[Backend Failed] User needs to enroll first.

PARAMETER_ERROR

[Backend Failed] The data submitted by our frontend is not valid. This may indicate a frontend bug.

IAM_FAILED

[Frontend Failed] User submits after leaving page open for over 1 hour.
Note: When errorCode = 'USER_TIMEOUT', this errorCode will be returned.

LIVENESS_TRY_COUNT_EXCEED

[Frontend Failed] Liveness detection try count exceeded the limit.
Note: When errorCode = 'RETRY_COUNT_REACH_MAX', this errorCode will be returned.

FACE_QUALITY_TOO_POOR

[Backend Failed] Face image quality too low (blurry, insufficient lighting, or wrong angle).

ERROR

[Backend Failed] System error, backend processing exception or network issue

Compatible Matrices

Supported browsers

Minimal browser versions with support for all features required by H5 Document Verification.

ChromeSafariEdgeOperaiOS SafariAndroid BrowserChrome for AndroidInternet Explorer
96159382158196Not supported

Sources:caniuse and WebAssembly Roadmap