API Overview
This section introduces all APIs that are provided for ZOLOZ's services, which are used for integrating with the ZOLOZ server.
CnAuthority
ZOLOZ CN Authority provides customers with solutions certified by the mainland official library. Users collect faces and compare them with the information stored in the official mainland library to verify the authenticity of this person's identity.
API | Endpoint | Description |
/api/v1/zoloz/cnauthority/verify | Used to collect face information and verify it with the CN authority database. A unique transaction ID is generated for the verifying process. |
Connect
ZOLOZ Connect provides a digital online solution for authentication. It implements a face verification process, which involves multiple capabilities of face liveness check and face comparison.
API | Endpoint | Description |
/api/v1/zoloz/connect/initialize | Initialize the face verification process in ZOLOZ. A unique transaction ID is generated for the process and used in all the subsequent interactions with the ZOLOZ server. | |
/api/v1/zoloz/connect/checkresult | Used to request the face verification process results. | |
/api/v1/zoloz/connect/enroll | Used to enroll a pre-captured face image of one user for subsequent usage of Connect Face Verify. This face image could come from the result of Real ID or Face capture. |
Real ID
ZOLOZ Real ID provides a digital online solution for KYC (Know Your Customer). It implements an identity proofing process, which involves multiple capabilities of document verification, face verification and risk control.
ZOLOZ Real ID supports two kinds of integration modes:
- App SDK mode, where users start the identity proofing process in a merchant application.
- H5 mode, where users start the identity proofing process via the mobile web browser.
API | Endpoint | Description |
/api/v1/zoloz/realid/initialize | 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. | |
/api/v1/zoloz/realid/checkresult | Used to request a result about the identity proofing process running status and other corresponding results, which include basic and detailed document verification results, face verification results, risk control results and so on. |
Face Compare
ZOLOZ Face Compare is used to compare two incoming face images and determine whether the two faces are of the same person, then output the comparison results.
API | Endpoint | Description |
/api/v1/zoloz/facecompare/compare | Perform a comparison check between two specified face images and return the comparison result. |
Face Capture
ZOLOZ Face Capture provides a digital online solution for capturing a user's selfie. It implements a face capture process that involves face liveness and face quality checks.
API | Endpoint | Description |
/api/v1/zoloz/facecapture/initialize | 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. | |
/api/v1a/zoloz/facecapture/checkresult | Used to request more information of the face capture process results. |
ID Recognition
ZOLOZ ID Recognition uses a variety of intelligent document algorithms for intelligent detection and information recognition of identity documents. It is suitable for a variety of scenarios such as remote identity authentication and automatic data entry, and more; which can effectively reduce labor costs and improve information processing efficiency.
API | Endpoint | Description |
/api/v1/zoloz/idrecognition/recognize | Provides the Optical Character Recognition (OCR) functionality for documents such as passports, ID cards and driving licenses, etc., along with anti-spoofing results for these documents. | |
/api/v1/zoloz/idrecognition/initialize | Used to initialize the ID recognition process in ZOLOZ. A unique transaction ID is generated for the ID recognition process and used in all the subsequent interactions with the ZOLOZ server. | |
/api/v1/zoloz/idrecognition/checkresult | Used to request a result about the ID recognition process running status and other corresponding results, which include basic and detailed document verification results. |
AML
AML Sanction Screening is a powerful watch-list screening solution with 100+ built-in algorithms and a comprehensive sanction/PEP/AM list for better screening results and sanction compliance programs.
API | Endpoint | Description |
/api/v1/aml/analyze | Provides screening capabilities with a user-defined watchlist. | |
/api/v1/aml/checkCaseResult | Provides query alert case results. |
NFC
ZOLOZ NFC Reader uses the NFC function of mobile devices to decode ID chips, read the encrypted information contained in these ID chips, and conveniently and efficiently extract ID information.
It is applicable for a variety of scenarios such as remote identity authentication, automatic data entry, and more; effectively improving overall data processing efficiency, reducing manpower costs as well as prevent attacks i.e. imitation ID images. With ZOLOZ NFC Reader, business security and risk control capabilities are greatly enhanced.
API | Endpoint | Description |
initialize | /api/v1/zoloz/nfc/initialize | Initialize the NFC reading process in the ZOLOZ. A unique transaction ID is generated for the process and used in all subsequent interactions with the ZOLOZ server. |
checkresult | /api/v1/zoloz/nfc/checkresult | Used to obtain the operational status of the NFC reading process and related identification results, including ID details, face details, etc. |
IdNetwork
ZOLOZ IdNetwork (IDN) builds out a network graph based on large amounts of historical data (i.e. face data, device information, user identity information, etc.) and uses computer vision algorithms, text algorithms, graph mining algorithms as well as retrieval techniques to identify large-scale batch fraud risks.
API | Endpoint | Description |
add | /api/v1/zoloz/idnetwork/add | Add a new record i.e. add a record to the database. |
risk query | /api/v1/zoloz/idnetwork/risk/query | Query the risks associated with a record. |
get | /api/v1/zoloz/idnetwork/get | Query record details. |
alliance get | /api/v1/zoloz/idnetwork/alliance/get | Query affiliate records. |
remove | /api/v1/zoloz/idnetwork/remove | Delete records. |
Blacklists
ZOLOZ Blacklist is an enhancement to Real ID, providing additional blacklist blocking capabilities within the eKYC process.
API | Endpoint | Description |
/api/v1/zoloz/blacklist/additem | Used to add an item to a target blacklist. | |
/api/v1/zoloz/blacklist/getitem | Used to obtain the details of an existing blacklist item. | |
/api/v1/zoloz/blacklist/removeitem | Used to delete an item from a target list. |
Privacy
ZOLOZ Privacy is an auxiliary function used to manage personal privacy information stored during the use of multiple products (i.e. Real ID, Face Capture, Face Compare, ID Recognition).
API | Endpoint | Description |
/api/v1/zoloz/privacyinfo/delete | Delete privacy Information, e.g. doc or face images, OCR or input information. |