This topic describes the API operations for 2-factor, 3-factor, and 4-factor bank card verification.
API description
API operation: BankMetaVerifyIntl
Request method: POST and GET
Transport protocol: HTTPS
Description: Verifies the consistency of bank card elements. This includes:
2-factor bank card verification (bank card number + name)
3-factor bank card verification (bank card number + name + certificate number)
4-factor bank card verification (bank card number + name + certificate number + mobile number)
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 debug this API operation in OpenAPI Explorer. You can also generate sample SDK code for this API operation.
Request parameters
Name | Type | Required | Description | Example |
ProductCode | String | Yes | Static field: BANK_CARD_N_META | BANK_CARD_N_META |
ParamType | String | Yes | Encryption method:
Important
| normal |
VerifyMode | String | Yes | VERIFY_BANK_CARD: Bank card authentication mode. This mode checks if the provided bank card number matches the user's real name, certificate number, and mobile number. | VERIFY_BANK_CARD |
ProductType | String | Yes | Product type to call:
| BANK_CARD_4_META |
BankCard | String | Yes | Bank card number:
|
|
UserName | String | Yes | Name:
|
|
IdentityType | String | No | Certificate type. If you leave this parameter empty, it defaults to ID card. For other certificate types, see the Certificate type list. | 01 |
IdentifyNum | String | No | Certificate number:
Important This parameter is required if ProductType is set to one of the following values:
|
|
Mobile | String | No | Mobile number:
Important This parameter is required if ProductType is set to BANK_CARD_4_META. |
|
Response parameters
Name | Type | Description | Example | |
RequestId | String | The request ID. | 130A2C10-B9EE-4D84-88E3-5384FF****** | |
Code | String | Success | ||
Message | String | A detailed description of the response code. | success | |
ResultObject | BizCode | String | Verification result:
| 1 |
SubCode | String | Verification details:
| 101 | |
Response codes
HTTP status code | Code | Message description |
200 | Success | The request was successful. |
400 | MissingParameter | A required parameter is missing. |
InvalidParameter | The parameter is invalid. | |
403 | Forbidden.RAMUserAccessDenied | The Resource Access Management (RAM) user does not have the AliyunAntCloudAuthFullAccess permission. For more information, see Grant a RAM user permissions to access a service. |
Forbidden.AccountAccessDenied | Ensure that you have enabled ID verification and that your account has no overdue payments. | |
Throttling.Api | The API call is blocked by throttling. | |
500 | InternalError | An internal error occurred. Contact technical support. |