Domain name for API request: faceid.intl.tencentcloudapi.com.
This API is used to validate the authenticity and consistency of the mobile number, name, and identity card number. For details on supported mobile number segments, see the carrier document.
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: PhoneVerification. |
| 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 |
| Phone | Yes | String | Mobile number. |
| CiphertextBlob | No | String | Users with encryption requirements can import the CiphertextBlob of kms. Read the data encryption document about encrypting data. |
| EncryptList.N | No | Array of String | When using the encryption service, fill in the field to be encrypted. -This API can fill in one or more of encrypted IdCard, Name, and Phone. |
| Iv | No | String | Users with encryption requirements import the initial vector for CBC encryption. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | String | Verification result code. -Fee result code Three-element information consistency. -4: Three-element information inconsistency. -No charge result code -6: Invalid phone number. -7: Identity number error. -8: Name verification failed. -9: No records. -11: The Verification Center Service is busy. -12: Authentication attempts exceeded the daily limit. Retry the next day. -13: The number range is unsupported for verification. |
| Description | String | Business result description. |
| Isp | String | ISP name. -Valid values: ["", "mobile", "telecom", "cucc"] |
| 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=PhoneVerification
&IdCard=11204416541220243X
&Name=Wei Xiaobao
&Phone=16137688175
&<Common request parameters>
{
"Response": {
"Result": "0",
"Description": "Authentication passed",
"Isp": "Telecom",
"RequestId": "a5fdb909-5ee6-43ff-a152-bb1b9744ee8b"
}
}
https://faceid.intl.tencentcloudapi.com/?Action=PhoneVerification
&IdCard=11204416541220243X
&Name=Wei Xiaobao
&Phone=16137688175
&<Common request parameters>
{
"Response": {
"Description": "Information inconsistency",
"Isp": "China Unicom",
"RequestId": "884a35af-289f-4b4e-a0b3-2315f02ab31e",
"Result": "-4"
}
}
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. |
| 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. |
文档反馈