Domain name for API request: faceid.intl.tencentcloudapi.com.
This API is used to validate the authenticity and consistency of the name and identity card number.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: IdCardVerification. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-01. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| IdCard | Yes | String | Identity card number. |
| Name | Yes | String | Name |
| Encryption | No | Encryption | Sensitive data encryption info. -Users with encryption requirements for incoming information (name, identity card number) can use this parameter. For details, please click the left-side link. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | String | Verification result code. Billing is as follows. -Result code for charges Name and identity card number match -Name and ID card number mismatch No charge result code: -2: Invalid ID number (incorrect length or check digit). -3: Invalid name (incorrect length, format, etc.) -4: Document library service exception -5: No ID card record found in the document library -6: The authoritative comparison system is being upgraded. Try again later. -7: Authentication attempts exceeded the daily limit. |
| Description | String | Business result description. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IdCardVerification
<Common request parameters>
{
"IdCard": "11204416541220243X",
"Name": "Wei Xiaobao"
}
{
"Response": {
"Result": "0",
"Description": "Name and identity card number match"
"RequestId": "94b54cdf-d975-4718-b091-32f8d79d6397"
}
}
POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IdCardVerification
<Common request parameters>
{
"IdCard": "440305199505132561",
"Name": "Liu Yang"
}
{
"Response": {
"Result": "-1",
"Description": "Name and ID card number mismatch"
"RequestId": "80c7abb8-4563-4636-98c3-0499f1611a33"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure.InvalidAuthorization | CAM signature/authentication error. |
| FailedOperation.DecryptSystemError | Decryption failed. |
| FailedOperation.StsUnAuthErrError | STS unauthorized. |
| FailedOperation.UnKnown | Unknown internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.UnsupportEncryptField | Unencrypted fields exist. Refer to the documentation to modify. |
| InvalidParameterValue | Incorrect parameter value. |
| UnauthorizedOperation.Arrears | The account is in arrears. |
| UnauthorizedOperation.ChargeStatusException | The billing status is abnormal. |
| UnauthorizedOperation.NonAuthorize | Identity verification has not been completed for the account. |
| UnauthorizedOperation.Nonactivated | The service has not been activated. |
文档反馈