ZOLOZZOLOZDOCS

Case Search

After connecting to ZOLOZ, you can search for cases using one or more fields on the case search page as well as export your case search results. At the same time, you can view the details of specified case results to help you better understand the product uses. 

Introducing case search function

Case search

You can search for product records using the search filters: Transaction ID, BizId, User ID, Product Type, Time, ID Number, TransactionId Suffix, Doc Type, Deleted Remark, and Result fields.

Picture 3.png

Field name

Description

transactionId

A unique transaction ID that is generated by the ZOLOZ server.

bizId

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.

userId

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.

Product Type

Product type, including Real ID, ID recognition, Face capture, Face compare, etc.

Time

The time the case was searched.

ID Number

The ID number. 

TransactionId Suffix

The suffix tied to the transactionId.

Doc Type

The type of ID. 

Deleted Remark

Whether private data has been deleted. 

Result

Product Results: 

  •  ALL: The sum of all product results, including the following seven results below. 
  • Success: Authentication succeeded.
  • Failure: Authentication failed. This may be due to a failed ID or face verification, or risk control processing. 
  • Pending: Authentication is pending. Note: This is a final response, and you are encouraged to view the application manually and then decide if the transaction should pass or not. If you encounter any issues during your review, please contact ZOLOZ's technical support. 
  • InProcess: Authentication is in progress. There is a certain delay during this state, and InProcess will change to VoidTimeout after a certain period of time. 
  • VoidTimeout: Authentication timeout. 
  • VoidCancelled: Authentication cancelled. 
  • Incomplete: This result is no longer in use, please ignore. 

Export Results

Support exporting case search results to meet your personalized data analysis needs.

Note：

  • Only admin and operator accounts can export case search results. Batch export is not supported for accounts under the same merchant; please export files one by one.
  • Up to 20,000 records can be exported in a single file.

Case search result details

In the case search result list, click View Detail on the right of the specified case to view the product’s specific result content. This article introduces the product result detail page of Real ID as an example, and includes the following five major elements:

Basic Information

Picture 4.png

Displays the basic information for a record, including the following:

  • User ID: userId. Merchant user ID, or other identifiers that can be used to identify a specific user.
  • Business ID: bizId. A unique business ID for tracing purpose. For example, the sequence ID from the merchant's business-related database.
  • Transaction ID: transactionId. A unique transaction ID that is generated by the ZOLOZ server.
  • Creation Time: The time when the transaction was created
  • Completion Time: Time of completion
  • Deleted Remark: Whether private data has been deleted
  • Device ID: Device identification number
  • OS: The system type of the user's device (if any)
  • Model: Phone brand information (if any)

Total Result

Display the overall business results of Real ID product and the results of each sub-module.

Picture 5.png

  • Finished: It displays whether the eKYC process is completed or not. Based on the transaction status, possible values include:
    • YES: When the Overall Result is any of  Success, Failure, and Pending, it means the current transaction process is completed.
    • NO: When the Overall Result is any of InProcess, VoidTimeout, VoidCancelled, and Incomplete, it means the current transaction is still in process or there occurred error in the process.
  • Overall Result: It is jointly determined by results of Document Verification Result, Face Verification Result and Risk Control Result. The ZOLOZ server compares and verifies the submitted ID photo and face selfie, and then returns the final result to the user in the form of Success, Pending or Failure.
    • Success: Authentication passed. Both the ID and face are authentic, and the comparison is consistent.
    • Failure: Authentication failed. There is a high risk present in this authentication e.g. the ID photo and face self are not of the same person; or the live face detection does not pass.
    • Pending: There are certain risks associated with this authentication and a second manual audit is required. The reasons for Pending include the document anti-counterfeit detection not passing; or that the face and document comparison score is not high enough and only approaches the threshold.

Document Verification Result

Displays sub-result details of the document module in Real ID. This includes document image display, document quality and classification test results, anti-counterfeit test results, and user-specific anti-counterfeit test results, document type, and document OCR recognition results. Please see ExtIdInfo field description in checkresult for the relevant field descriptions.

The mapping relationship between Document Verification Result fields in Portal and checkresult API fields is as follows:

Portal Field

checkresult Field

Description

Document Quality Check Result

docErrorDetails

  • When Document Quality Check result is Pass, the return value of docErrorDetails may be：
    • Null
    • NOT_REAL_DOC
  • When Document Quality Check result is Failure, there may appear two kinds of results as follows:
    • No failure reason details in Portal, but docErrorDetails returned NOT_REAL_DOC.
    • One of the failure reason details (NO_REQUIRED_ID, BLUR, NO_FACE_DETECTED, EXPOSURE and UNKNOWN) is displayed in Portal, which corresponds with the return value of docErrorDetails.

Spoofing Check Result

spoofResult

Their return values are the same.

Details of more specified spoofing check items

extraSpoofResultDetails

Their return values are the same.

Document Type

certType

Their return values are the same.

Document Edition

docEdition

Their return values are the same.

OCR Result

ocrResult

Their return values are the same.

Face Verification Result

Displays sub-result details of the face module in Real ID. This includes face image display, live face detection result, face image quality detection result, and face authentication comparison result. Please see ExtFaceInfo field description in checkresult for the relevant field descriptions. 

The mapping relationship between Face Verification Result fields in Portal and checkresult API fields is as follows:

Portal Field

checkresult Field

Description

Liveness Check

faceLivenessResult

Their return values are the same.

Photo Quality Check

faceQuality

Photo Quality Check displays the overall result of face quality.
Notes：

  • Photo Quality Check includes not only faceQuality but also factors that custormers care about. Currently, these factors include mask and face occlusion detection.
  • When the mask detection, face occlusion detection, and faceQuality check are all passed, the Photo Quality Check is set as Pass. Otherwise, if any of these fails, Photo Quality Check is set as Failure.
Match Result

faceScore

Match Result represents the face comparison result. faceScore returns the face comparison score. Based on the relationship between the returned face comparison score and the set threshold, Match Result determines the final result, Pass or Failure.

Note: When the result of Liveness Check or Photo Quality Check is Failure, there is no return value for Match Result.

Match Score

faceScore

Their return values are the same.

Risk Control Result

Displays sub-result details of the risk policy module in Real ID. Contains the specific type of risk policy for the current transaction. When the ID Network or blacklist risk module is hit, the specific details of the hit will be displayed. Please see ExtRiskInfo field description in checkresult for the relevant field descriptions.

Note: When the return value of Risk Control Result is empty, please refer to Why is the return value of Risk Control Result in Real ID empty?

The mapping relationship between Risk Control Result fields in Portal and checkresult API fields is as follows:  

Portal Field

checkresult Field

Description

Strategy Pass Result

strategyPassResult

Their return values are the same.