Domain name for API request: faceid.intl.tencentcloudapi.com.
This API is used to validate the authenticity and consistency of the name, identity card number, and valid period.
A maximum of 20 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: CheckIdNameDate. |
| 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. |
| Name | Yes | String | Name |
| IdCard | Yes | String | Identity card number. |
| ValidityBegin | Yes | String | ID card validity start time. -Format: YYYYMMDD, for example: 20210701. |
| ValidityEnd | Yes | String | ID card expiration time. Format: YYYYMMDD, use "00000000" for long-term, for example: 20210701. |
| 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 Same. -1: Inconsistent. -Result code with no charge -2: Invalid ID number (incorrect length or check digit). -3: Invalid name (incorrect length or format). -4: Invalid validity period (incorrect length, format, etc.). -5: Invalid identity information. -6: Document library service exception. -7: No ID card record found in the document library. -8: Authentication attempts exceeded the daily limit. Retry the next day. |
| 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. |
https://faceid.intl.tencentcloudapi.com/?Action=CheckIdNameDate
&Name=Wei Xiaobao
&IdCard= 11204416541220243X
&ValidityBegin=20160204
&ValidityEnd=20260204
&<Common request parameters>
{
"Response": {
"Result": "0",
"Description": "Consistent",
"RequestId": "8695c53f-776f-4ff5-a66d-84e67b352d20"
}
}
https://faceid.intl.tencentcloudapi.com/?Action=CheckIdNameDate
&Name=Wei Xiaobao
&IdCard= 11204416541220243X
&ValidityBegin=20160204
&ValidityEnd=20260204
&<Common request parameters>
{
"Response": {
"Description": "Inconsistent",
"RequestId": "af4075de-427f-48a5-85cb-2be5b3751b76",
"Result": "-1"
}
}
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 |
|---|---|
| FailedOperation.DecryptSystemError | Decryption failed. |
| FailedOperation.StsUnAuthErrError | STS unauthorized. |
| InternalError | Internal error. |
| 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. |
文档反馈