Analyze credential images to detect forgery, tampering, screen captures, and recaptures using the CredentialVerifyIntl API.
API description
-
Operation name: CredentialVerifyIntl
-
Description: Analyzes credential images to detect forgery, tampering, screen captures, and recaptures.
-
Request method: POST
-
Transport protocol: HTTPS
-
QPS limit: Each API has a dedicated QPS limit. For details, see QPS limits of ID Verification server-side APIs.
-
Endpoints:
NoteBenefits of internal network access: An internal network enables private communication between Alibaba Cloud services in the same region. If your application server is also in the same region, use the internal network endpoint to access the ID Verification service for a more secure and stable connection.
Optimization for overseas access: Network conditions outside the Chinese mainland can be complex. To reduce latency and minimize request failures, optimize your integration by following the best practices in Server-side Network Latency Analysis and Optimization.
Singapore
Public endpoint:
cloudauth-intl.ap-southeast-1.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
-
Credential detection is AI-based with approximately 90% accuracy on internal test data. Actual accuracy varies by scenario.
-
Detection is more effective on native camera photos than on digitally synthesized images.
-
Do not rely solely on detection results to verify credential authenticity. Use them to supplement or accelerate manual reviews.
-
Common use cases include finance, payment acquiring, and e-commerce merchant onboarding. For other scenarios, contact your account manager.
Online debugging and integration
Before you debug or integrate, read the Debug and integrate server-side APIs with OpenAPI guide to understand how to call APIs on the OpenAPI platform and how to obtain the SDK.
You can debug this operation directly in OpenAPI Explorer. You can also generate SDK sample code for this operation.
Request parameters
The image specified by the ImageUrl or ImageFileObject parameter must meet the following requirements:
-
Image format: PNG, JPG, JPEG, BMP, and WebP.
-
Image dimensions: Height and width must be greater than 15 px and less than 8192 px. Aspect ratio must be less than 50.
NoteFor best results, use images with height and width both greater than 500 pixels.
-
Image size: URL images cannot exceed 10 MB.
ImageFileObjectimages cannot exceed 3 MB.NoteLarge images increase response time. Keep images under 3 MB.
|
Name |
Type |
Required |
Description |
Example |
|
CredType |
String |
Yes |
Credential type:
|
03 |
|
CredName |
String |
Yes |
Credential name (use the numeric code):
Note
To support more credential types, contact your account manager. |
0301 |
|
ProductCode |
String |
Yes |
Call mode:
|
ANTI_FAKE_CHECK |
|
ImageUrl |
String |
Yes Important
Specify either imageUrl or ImageFileObject. |
The URL of the image. |
https://example.com/test.jpg |
|
ImageFileObject |
InputStream |
The image file stream. To upload an image this way, you must call the Advance API and pass a valid InputStream object. For more information, see Special scenario: Configure the Advance API for file uploads. |
The InputStream object of the image |
Response parameters
|
Name |
Type |
Description |
Example |
|
|
RequestId |
String |
The request ID. |
130A2C10-B9EE-4D84-88E3-5384******** |
|
|
Code |
String |
Important
|
Success |
|
|
Message |
String |
A detailed description of the return code. |
success |
|
|
ResultObject |
Result |
String |
|
1 |
|
RiskTag |
String |
Risk tags, comma-separated. Valid values:
|
PS |
|
|
RiskScore |
Map<String,String> |
Risk score for each detected tag. Ranges from 0 (no risk) to 1 (risk detected). |
|
|
|
MaterialInfo |
String |
Other information. This is a reserved field. |
||
Return codes
|
HTTP status code |
Code |
Description |
|
200 |
Success |
Success. |
|
400 |
MissingParameter |
A required parameter is missing. |
|
400 |
Forbidden.ExceptionRepeatedInvoke |
Duplicate request detected. |
|
401 |
InvalidParameter |
The parameter is invalid. |
|
401 |
UnqualifiedPhoto |
The provided image is not usable. |
|
401 |
ToolargeImage |
The provided image is too large. |
|
401 |
DataDuplication |
The data is duplicate. |
|
403 |
Forbidden.AccountAccessDenied |
Make sure that you have activated ID Verification and your account has no overdue payments. |
|
403 |
Forbidden.RAMUserAccessDenied |
RAM user requires AliyunAntCloudAuthFullAccess permission. |
|
500 |
Forbidden.ExceptionDataSource |
Authoritative data source service error. |
|
500 |
InternalError |
Internal system error. Contact support for troubleshooting. |