This topic describes the API operation for two-factor ID verification.
Two-factor ID verification
API operation: Id2MetaVerifyIntl
Request method: POST and GET
Protocol: HTTPS
Description: Verifies that a name and an ID card number match.
For API-specific QPS limits, see ID Verification server-side API QPS limits.
Endpoints:
NoteAn internal endpoint refers to the internal communication network between Alibaba Cloud products in the same region. If your business server is deployed in the corresponding Alibaba Cloud region, you can access the ID Verification service through an internal endpoint to ensure more secure and stable network communication.
China (Hong Kong)
Public endpoint:
cloudauth-intl.cn-hongkong.aliyuncs.comInternal endpoint:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
Online debugging and integration
Before you start debugging and integration, read the Use OpenAPI to debug and integrate server-side APIs document to understand how to call API operations on the OpenAPI platform and obtain the SDK and its code.
You can run this API operation in OpenAPI Explorer to perform a test and generate an SDK code sample.
Request parameters
Name | Type | Required | Description | Example |
ProductCode | String | Yes | The product plan. This is a static field. Set the value to ID_2META. | ID_2META |
ParamType | String | Yes | The parameter type. normal: The original value in plaintext. Note Due to limitations of the authoritative data source, two-factor ID verification does not support MD5 encryption. | normal |
IdentifyNum | String | Yes | The ID card number. Note Only ID cards of residents in the Chinese mainland are supported. | 411***********0001 |
UserName | String | Yes | The name. | Zhang* |
Response parameters
Name | Type | Description | Example | |
RequestId | String | The request ID. | 130A2C10-B9EE-4D84-88E3-5384FF039795 | |
Code | String | Success | ||
Message | String | The detailed description of the response code. | success | |
Result | Object | None. | None | |
| BizCode | String | The verification result:
| 1 |
Return Code
HTTP status code | Code | Description |
200 | Success | The request was successful. |
400 | MissingParameter | A parameter cannot be empty. |
Forbidden.ExceptionRepeatedInvoke | The number of repeated abnormal calls exceeds the limit. | |
401 | InvalidParameter | Invalid parameter. |
403 | Forbidden.AccountAccessDenied | Activate ID Verification and ensure that your account has no overdue payments. |
Forbidden.RAMUserAccessDenied | Grant the AliyunAntCloudAuthFullAccess permission to the Resource Access Management (RAM) user. | |
500 | Forbidden.ExceptionDataSource | The authoritative data source service is abnormal. |
InternalError | An internal system error occurred. Contact our engineers for troubleshooting. |