This document describes the server-side APIs for Alibaba Cloud ID Verification. Call these APIs to integrate the service.
The public endpoint for the service is cloudauth-intl.[region].aliyuncs.com. The following table lists the queries per second (QPS) limit for each API in each region.
Region | Region ID | QPS for a single API |
Singapore | ap-southeast-1 | 10 |
China (Hong Kong) | cn-hongkong | 10 |
Malaysia (Kuala Lumpur) | ap-southeast-3 | 3 |
Indonesia | ap-southeast-5 | 3 |
Notes on QPS limits:
The QPS limit specified in this document applies to each API under an Alibaba Cloud account. This limit is shared by all Resource Access Management (RAM) users under the same account.
If your traffic exceeds the specified QPS limit, contact the product and business teams to request a scale-out.
The QPS limit for server-side APIs may vary by region. The limits specified in this document are authoritative.
Because of compliance requirements, the service in Malaysia and Indonesia uses a local deployment. Before you integrate the service, contact the product team to confirm the QPS limit.
ID verification
This service provides an end-to-end online solution for identity verification that combines key capabilities such as document verification, liveness detection, and risk assessment.
This service supports the following three integration modes:
App SDK mode: The user starts the identity verification process in the merchant's mobile app.
Web SDK mode: The user starts the identity verification process in a mobile or desktop browser.
WebView-embedded app mode: The user starts the identity verification process in the merchant's mobile app by using an embedded WebView.
App SDK, Web SDK, and WebView-embedded app
API name | Description | Documentation | OpenAPI portal |
InitializeV2 | Call this API before starting an eKYC PRO authentication flow to obtain a For Web SDK and WebView-embedded app modes, the API also returns a ProductCode: | ||
CheckResult | After you receive a callback notification, call this API to get the authentication status and results, which include the face verification result, document OCR result, and risk assessment result. The results are retained for 30 days. |
Liveness detection
This service offers an online authentication solution that uses only face liveness detection to verify a user's identity, eliminating the need for document verification.
This service supports the following four integration modes:
App SDK mode: The user completes the liveness detection process in the merchant's mobile app.
Web SDK mode: The user completes the liveness detection process in a mobile or desktop browser.
WebView-embedded app mode: The user completes the liveness detection process in the merchant's mobile app by using an embedded WebView.
Server-side only (API) mode: The merchant directly submits pre-collected face images, and the server performs liveness detection without requiring client SDK integration.
App SDK, Web SDK, and WebView-embedded app
API name | Description | Documentation | OpenAPI portal |
InitializeV2 | Call this API before starting a liveness authentication flow to obtain a For Web SDK and WebView-embedded app modes, the API also returns a ProductCode: | ||
CheckResult | After receiving a callback notification, call this API to get the authentication status and results, including the liveness authentication result. The results are retained for 30 days. |
Server-side only (API)
API name | Description | Documentation | OpenAPI portal |
FaceLivenessV2 | Directly submit a face image to perform liveness and deepfake detection using the Qwen-VL model, without requiring an SDK or interactive liveness challenges. This mode is suitable for scenarios with relatively low security requirements. For high-security scenarios, an SDK mode is recommended. ProductCode: |
Face Identity Unique
Provides multiple liveness verification solutions, including face verification (1:1) and anti-duplication detection (1:N search) modes. This service is suitable for preventing duplicate registrations and identity fraud.
This service supports the following four integration modes:
App SDK mode: The user completes the liveness verification, face verification, or anti-duplication search process in the merchant's mobile app.
Web SDK mode: The user completes the liveness verification, face verification, or anti-duplication search process in a mobile or desktop browser.
WebView-embedded app mode: The user completes the liveness verification, face verification, or anti-duplication search process in the merchant's mobile app by using an embedded WebView.
Server-side only (API) mode: The merchant directly submits pre-collected face images, and the server performs liveness verification, face verification, or anti-duplication search without requiring client SDK integration.
App SDK, Web SDK, and WebView-embedded app
API name | Description | Documentation | OpenAPI portal |
InitializeV2 | Call this API before starting an authentication flow to obtain a For Web SDK integration, the API also returns a ProductCode: | ||
CheckResult | After receiving a callback notification, call this API to get the authentication status and results. The response includes the liveness authentication result, face comparison score ( |
Server-side only (API)
API name | Description | Documentation | OpenAPI portal |
FaceVerifyIntl | Directly submit a face image to perform duplicate face detection and comparison without an SDK. This API supports 1:1 verification, 1:N search, and combined modes. ProductCode: |
Face database management
Face database management is not a standalone product but a management feature of the 1:N detection solution in liveness verification. It is used to manage face database data for 1:N searches.
API name | Description | Documentation | OpenAPI portal |
AddFaceRecord | Registers a user's face image to a specified face database. The API accepts input as a Base64 string, URL, or local file stream, and returns the registration result and a face quality assessment. | ||
DeleteFaceRecordV2 | Deletes a face image from a face database using the unique user identifier |
Face comparison
This server-side only API compares the similarity of two face images and determines if they belong to the same person.
This service supports the following integration mode:
Server-side only (API) mode: The merchant directly submits two face images. The server performs the comparison and returns the result and a score. No client SDK integration is required.
Server-side only (API)
API name | Description | Documentation | OpenAPI portal |
FaceCompareV2 | Submits two face images to determine if they belong to the same person. The API returns a comparison result ( |
ID OCR
This service provides a document recognition solution based on the Qwen-VL model. It supports automatic detection and information extraction for various types of identity documents worldwide and is suitable for remote identity authentication and automatic data entry.
This service supports the following four integration modes:
App SDK mode: The user completes the ID OCR process in the merchant's mobile app.
Web SDK mode: The user completes the ID OCR process in a mobile or desktop browser.
WebView-embedded app mode: The user completes the ID OCR process in the merchant's mobile app by using an embedded WebView.
Server-side only (API) mode: The merchant directly submits pre-collected document images, and the server performs OCR without requiring client SDK integration.
App SDK, Web SDK, and WebView-embedded app
API name | Description | Documentation | OpenAPI portal |
InitializeV2 | Call this API before starting a document OCR authentication flow to obtain a ProductCode: | ||
CheckResult | After you receive a callback notification, call this API to get results from the server. The Qwen-VL model automatically recognizes the document type and extracts structured information. This API supports front and back side recognition and anti-spoofing detection. |
Server-side only (API)
API name | Description | Documentation | OpenAPI portal |
DocOcrMaxV2 | Submits a document image. The Qwen-VL model automatically recognizes the document type and extracts structured information. This API supports front and back side recognition and anti-spoofing detection. ProductCode: |
ID NFC
This recognition solution uses a mobile phone's Near Field Communication (NFC) to decode document chips. It reads encrypted information from the document chip to help prevent attacks from synthetic document images and enhance business security. This feature currently supports global passports.
This service supports the following integration mode:
App SDK mode: The user completes the ID NFC process in the merchant's mobile app.
App SDK
API name | Description | Documentation | OpenAPI portal |
InitializeV2 | Call this API after the client obtains ProductCode: | ||
CheckResult | Retrieves the NFC reading result, which includes the complete structured information of the passport (such as name, document number, nationality, and expiration date) and a Base64-encoded face photo. The results are retained for 30 days. |
Device Guard
Device Guard is a device risk identification solution for independent use or as an auxiliary risk control feature. It collects a device token through a client SDK and queries the device risk assessment result from the server to identify risks such as rooted or jailbroken devices, VPNs, emulators, virtual environments, and abnormal behavior.
This service supports the following two integration modes:
App SDK mode: No user-facing business process is involved.
Web SDK mode: No user-facing business process is involved.
App SDK and Web SDK
API name | Description | Documentation | OpenAPI portal |
FaceGuardRisk | Submits the ProductCode: |
Credential tampering detection
This service provides risk detection to determine whether an image has been edited, screen-captured, recaptured, or tampered with.
This service supports the following integration mode:
Server-side only (API) mode: The merchant directly submits a credential image, and the server performs the risk assessment without requiring client SDK integration.
Server-side only (API)
API name | Description | Documentation | OpenAPI portal |
CredentialVerifyIntl | Submits credential image information and returns an assessment of risks such as forgery, tampering, screen capture, and recapture. ProductCode: |
Credential recognition
Powered by the Qwen-VL model, this service recognizes and extracts key information from user-uploaded credential documents. It outputs structured data and offers an optional forgery detection feature.
This service supports the following integration mode:
Server-side only (API) mode: The merchant directly submits a credential image or PDF file. The server recognizes key information and assesses forgery risk without requiring client SDK integration.
Server-side only (API) - synchronous call
API name | Description | Documentation | OpenAPI portal |
CredentialRecognitionIntlV2 | Submits a credential image or PDF file to recognize key information and assess forgery risk. ProductCode: |
Server-side only (API) - asynchronous call
API name | Description | Documentation | OpenAPI portal |
CredentialSubmitIntlV2 | Submits a credential image or PDF file to start a recognition task and get a ProductCode: | ||
CredentialGetResultIntl | Asynchronously retrieves key information and forgery risk assessment results by using a ProductCode: |
Indonesia authoritative source verification service
An independent identity information verification service for Indonesia. It also serves as a supplement to the eKYC_PRO solution for authoritative source verification scenarios. This service enhances user identity credibility by comparing the user-submitted national ID number, name, face image, and date of birth against an official database to verify consistency.
This service supports the following integration mode:
Server-side only (API) mode: The merchant directly submits identity information and a face image for server-side verification and comparison. No client SDK integration is required.
Server-side only (API)
API name | Description | Documentation | OpenAPI portal |
IdnAuthorityVerifyIntl | Submits identity information and a face image to the server for authoritative source verification and returns the comparison result. ProductCode: |
Query authentication logs
This utility API for self-service troubleshooting lets you query end-to-end logs with a TransactionId to analyze incomplete authentication processes and identify reasons for user drop-off. This API is free of charge. You can query logs only for solutions that involve client-side integration and not for server-side only (API) solutions.
API name | Description | Documentation | OpenAPI portal |
CheckVerifyLog | Submits the |
Delete authentication records
This utility API deletes sensitive information and data from the authentication results of some product solutions.
API name | Description | Documentation | OpenAPI portal |
DeleteVerifyResult | Submits the |
Client-side connection keep-alive
This utility API maintains the client connection when the server calls ID Verification APIs infrequently.
API name | Description | Documentation | OpenAPI portal |
KeepaliveIntl | This API has no input parameters and no specific business logic. When the server calls ID Verification APIs infrequently, the client can proactively call this API to keep the connection alive. |