H5 Demo User Guide

2025-01-08 01:36

The ZOLOZ H5 Demo now fully supports ZOLOZ's core products, including RealID, Face Capture, and ID Recognition, providing you with secure and convenient identity verification solutions.

Supported Products

Through the ZOLOZ H5 Demo, you can freely try and experience the following products:

RealID
Face Capture
ID Recognition

RealID

Contact the ZOLOZ BD team and provide your email address to receive the H5 Demo link.
Enter the Demo experience page and click "Verify Now" on the right side of RealID to enter the RealID process guide page.
On the RealID process guide page, click "Start" to set up document and face capture related features.

On the "Choose ID Type" page, select the country or region and the type of document, then click "Take ID Picture."
On the "Select verification level" page, configure the collection method and related parameters according to the recommended settings in the table below.

Field Name	Description
Capture Mode	Document Capture Methods `Self Capture`: Manual version, with basic anti-counterfeiting capabilities. Users manually align the document with the frame based on page prompts, take a picture, and confirm its clarity. `Auto Capture`: Scan version, supported only on H5, with advanced anti-counterfeiting capabilities. ZOLOZ automatically captures and uploads the document photo once the document is aligned with the frame. `Multi Angle`: Multi-angle version, supported only on H5 and applicable only for Hong Kong's first and second-generation ID cards, with advanced anti-counterfeiting capabilities. Users need to take a straight-on photo and a photo with the document tilted at a 30° angle.
Spoof Mode	Document Anti-Counterfeiting Modes `Closed`: All anti-counterfeiting algorithms are turned off. This mode can be used for testing scenarios, as the testing process is not affected by algorithms and risk control rules. `Standard`: Recommended standard mode with document anti-counterfeiting detection algorithms enabled. `Loose`: Reserved value, not currently supported. `Strict`: Reserved value, not currently supported.
Action Check Items	Face Capture Actions `FACEBLINK`: Blink `MOUTHOPEN`: Open mouth `HEADSHAKE`: Shake head (left or right, random) `HEADLOWER`: Lower head `HEADRAISE`: Raise head
Action Random	Whether the Sequence of Face Capture Actions is Random `Y`: Random `N`: Not random, follows the order listed in Action Check Items.
Action Frame	Additional Frame Images Collected. Currently, only supports Eye Close, indicating a closed-eye frame. This image will be returned in the checkResult API. Note: Setting this parameter in the H5 Demo will not affect the anti-counterfeiting capability test.
Liveness Mode	Face Liveness Detection Modes `Closed`: Face liveness detection algorithm is not enabled. `Standard`: Recommended standard mode with face liveness detection algorithm enabled. `Loose`: Relatively lenient mode, suitable for low-risk scenarios. `Strict`: Relatively strict mode, suitable for high-risk scenarios.
AntiInjection Mode	Anti-Injection Mode for Face Detection `Closed`: Face anti-injection detection algorithm is not enabled. `Standard`: Recommended standard mode with the face anti-injection detection algorithm enabled. `Loose`: Reserved value, not currently supported. `Strict`: Reserved value, not currently supported. Note: Anti-Injection Mode is a trial feature. Please contact ZOLOZ technical support to activate this feature.
Risk Mode	Risk Control Modes `Closed`: Risk detection algorithm is not enabled. `Standard`: Recommended standard mode with risk detection algorithm enabled. `Loose`: Relatively lenient mode, suitable for low-risk scenarios. `Strict`: Relatively strict mode, suitable for high-risk scenarios.
Idn Threshold	IDN Threshold, supports setting any integer greater than 0. This can be used to intercept transactions involving the same merchant with different IDs for the same face or different faces for the same ID. When the number of related transactions between different userIds exceeds the specified threshold, they will be intercepted.

Collection of ID and Face Images

ID Collection: Align the ID with the collection frame according to the on-screen instructions.
Face Collection: Face the phone screen directly and follow the on-screen instructions to perform the required actions for collection.

After successful collection, check the eKYC verification results.

Field Name	Description
ekycResult	eKYC Overall Result `Success`: Identity verification passed. `Pending`: Identity verification result is pending manual review. `Failure`: Identity verification failed, possibly due to document verification, face verification, or risk control processing failure.
ekycResultDoc	Document Module Verification Result `Success`: Document verification passed. `Pending`: Document verification result is pending manual review. `Failure`: Document verification failed.
spoofResult	Document Anti-Counterfeiting Detection Result `Y`: Document anti-counterfeiting detection passed. `N`: Document anti-counterfeiting detection failed. Below are the detailed results for document anti-counterfeiting detection. "Y" indicates the detection passed, and "N" indicates the detection did not pass. The detection items vary with different types of documents, so the returned detection result items will also differ. All anti-counterfeiting detection items supported by ZOLOZ are as follows: `SCREEN_RECAPTURE_CHECK`: Screen recapture detection. `INFORMATION_CHECK`: Information verification check, only supports detection of ID, name, and symbol on Hong Kong first and second-generation ID cards, returning the detection results; other documents will return the OTHER_CHECK field. `MATERIAL_CHECK`: Material detection. `SECURITY_FEATURE_CHECK`: Security feature detection, only supports detection of security features on Hong Kong first and second-generation ID cards and Malaysian MyKad, returning the detection results; other documents will return the `OTHER_CHECK` field. `TAMPER_CHECK`: Obstruction and tampering detection.
ekycResultFace	Face Module Verification Result `Success`: Face verification passed. `Pending`: Face verification result is pending manual review. `Failure`: Face verification failed.
faceScore	Live face and document face comparison score, the score ranges from 0 to 100, with higher scores indicating greater similarity.
faceQuality	Face quality score, the score ranges from 0 to 100, with higher scores indicating better quality of the face image.
faceLivenessResult	Face Liveness Detection Result `Success`: Face liveness detection passed. `Failure`: Face liveness detection failed, which may indicate a spoofing attack.
ekycResultRisk	Risk Control Module Verification Result `Success`: Risk control verification passed. `Pending`: Risk control result is pending manual review. `Failure`: Risk control verification failed.
idNetworkDetails	Detailed information output by IDN, this field is returned only when strategyPassResult returns `ID_NETWORK_HIGH_RISK`. For more details, refer to ExtRiskInfo.
strategyPassResult	Risk Detection Result Details `PASS`: Risk detection passed. `VELOCITY_HIGH_RISK`: High risk detected by the risk control engine. `ID_NETWORK_HIGH_RISK`: Multiple transactions detected with IDN risk, such as the same face with different documents or the same document with different faces. `BLACKLIST_HIGH_RISK`: Blacklist hit detected. `AGE_MISMATCH_HIGH_RISK`: Significant age difference detected between the live face and the document face.
OCR_Result	OCR recognition result, this result displays the field information recognized from the document.

Face Capture

Contact the ZOLOZ BD team and provide your email address to obtain the H5 Demo link.
Enter the Demo experience page, and click "Verify Now" on the right side of Face Capture to enter the "Set Verification Parameters" page.
On the "Set Verification Parameters" page, set the feature-related parameters according to the recommended configuration in the table below.

Field Name	Description
Action Check Items	Face Capture Actions `FACEBLINK`: Blink `MOUTHOPEN`: Open mouth `HEADSHAKE`: Shake head (left or right, random) `HEADLOWER`: Lower head `HEADRAISE`: Raise head
Action Random	Whether the Sequence of Face Capture Actions is Random `Y`: Random `N`: Not random, follows the order listed in Action Check Items.
Action Frame	Additional Frame Images Collected. Currently, only supports Eye Close, indicating a closed-eye frame. This image will be returned in the checkResult API. Note: Setting this parameter in the H5 Demo will not affect the anti-counterfeiting capability test.
Liveness Mode	Face Liveness Detection Modes `Closed`: Face liveness detection algorithm is not enabled. `Standard`: Recommended standard mode with face liveness detection algorithm enabled. `Loose`: Relatively lenient mode, suitable for low-risk scenarios. `Strict`: Relatively strict mode, suitable for high-risk scenarios.
AntiInjection Mode	Anti-Injection Mode for Face Detection `Closed`: Face anti-injection detection algorithm is not enabled. `Standard`: Recommended standard mode with the face anti-injection detection algorithm enabled. `Loose`: Reserved value, not currently supported. `Strict`: Reserved value, not currently supported. Note: Anti-Injection Mode is a trial feature. Please contact ZOLOZ technical support to activate this feature.

On the "Verify Face" page, position your face directly in front of the phone screen and follow the on-screen prompts to complete the corresponding actions for face image capture.
After a successful capture, review the face verification results.

Field Name	Description
Verification Result	Overall Face Capture Result `Success`: Both the overall face quality result and the liveness detection passed. `Failure`: The authentication poses a high risk and is recommended to be rejected, e.g., either the overall face quality result or the liveness detection did not pass. `VoidTimeout`: No face capture result obtained, face capture timed out. `InProcess`: No face capture result obtained, face capture is in progress.
Quality Score	Face quality score, the score ranges from 0 to 100, with higher scores indicating better quality of the face image.
Quality Passed	Overall face quality result. Face quality detection supports multiple modules, including face quality score, mask detection, and occlusion detection. By default, it checks the face quality score (whether the face is clear, complete, etc.). You can enable more detection items based on your actual business needs. `true`: Quality check passed. `false`: Quality check failed, either the face quality score or other detection modules have failed items.
Face Attack	Face Liveness Detection Result `true`: Face liveness detection failed, possible spoofing attack detected. `false`: Face liveness detection passed. Note: When the value of Quality Passed is`false`, the return value of this field is null.

ID Recognition

Contact the ZOLOZ BD team and provide your email address to obtain the H5 Demo link.
Enter the Demo experience page, and click "Verify Now" on the right side of ID Recognition to enter the "Choose ID Type" page.
On the "Choose ID Type" page, select the country or region and the type of ID document, then click "Take ID Picture."
On the "Set Verification Parameters" page, configure the collection method and operation mode according to the recommended settings in the table below.

Field Name

Description

Capture Mode

Document Capture Methods

Self Capture: Manual version, with basic anti-counterfeiting capabilities. Users manually align the document with the frame based on page prompts, take a picture, and confirm its clarity.
Auto Capture: Scan version, supported only on H5, with advanced anti-counterfeiting capabilities. ZOLOZ automatically captures and uploads the document photo once the document is aligned with the frame.
Multi Angle: Multi-angle version, supported only on H5 and applicable only for Hong Kong's first and second-generation ID cards, with advanced anti-counterfeiting capabilities. Users need to take a straight-on photo and a photo with the document tilted at a 30° angle.

Operation Mode

Operation Modes for Identity Verification

Closed: All algorithms and risk control rules are disabled. This mode can be used for testing scenarios where the testing process is not affected by algorithms and risk control rules.
Standard: Recommended standard mode.
Loose: Relatively lenient mode, suitable for low-risk scenarios.
Strict: Relatively strict mode, suitable for high-risk scenarios.
Standard Risk Level 1: Disables the Velocity feature.
Standard Risk Level 2: Disables the IDN feature.
Standard Risk Level 3: Disables both Velocity and IDN features.

On the "Verify Identity" page, follow the on-screen prompts to align the ID document with the capture frame and take the ID document picture.
After a successful capture, review the ID verification results.

Field Name	Description
ekycResult	Overall ID Verification Result `Y`: ID verification passed. `N`: ID verification passed.
spoofResult	Document Anti-Counterfeiting Detection Result `Y`: Document anti-counterfeiting detection passed. `N`: Document anti-counterfeiting detection failed. Below are the detailed results for document anti-counterfeiting detection. "Y" indicates the detection passed, and "N" indicates the detection did not pass. The detection items vary with different types of documents, so the returned detection result items will also differ. All anti-counterfeiting detection items supported by ZOLOZ are as follows: `SCREEN_RECAPTURE_CHECK`: Screen recapture detection. `INFORMATION_CHECK`: Information verification check, only supports detection of ID, name, and symbol on Hong Kong first and second-generation ID cards, returning the detection results. `MATERIAL_CHECK`: Material detection. `SECURITY_FEATURE_CHECK`: Security feature detection, only supports detection of security features on Hong Kong first and second-generation ID cards and Malaysian MyKad, returning the detection results. `TAMPER_CHECK`: Obstruction and tampering detection.
OCR_Result	OCR recognition result, this result displays the field information recognized from the document.