接口请求域名: faceid.intl.tencentcloudapi.com 。
本接口用于校验手机号、姓名和身份证号的真实性和一致性。支持的手机号段详情请查阅运营商类文档。
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:PhoneVerification。 |
| Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| IdCard | 是 | String | 身份证号。 |
| Name | 是 | String | 姓名。 |
| Phone | 是 | String | 手机号。 |
| CiphertextBlob | 否 | String | 有加密需求的用户,传入kms的CiphertextBlob。关于数据加密可查阅 数据加密 文档。 |
| EncryptList.N | 否 | Array of String | 在使用加密服务时,填入要被加密的字段。 - 本接口中可填入加密后的IdCard,Name,Phone中的一个或多个。 |
| Iv | 否 | String | 有加密需求的用户,传入CBC加密的初始向量。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 认证结果码。 - 收费结果码 0: 三要素信息一致。 -4: 三要素信息不一致。 - 不收费结果码 -6: 手机号码不合法。 -7: 身份证号码有误。 -8: 姓名校验不通过。 -9: 没有记录。 -11: 验证中心服务繁忙。 -12: 认证次数超过当日限制,请次日重试。 -13:该号段不支持验证 |
| Description | String | 业务结果描述。 |
| Isp | String | 运营商名称。 - 取值范围为["","移动","电信","联通"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
https://faceid.intl.tencentcloudapi.com/?Action=PhoneVerification
&IdCard=11204416541220243X
&Name=韦小宝
&Phone=16137688175
&<公共请求参数>
{
"Response": {
"Result": "0",
"Description": "认证通过",
"Isp": "电信",
"RequestId": "a5fdb909-5ee6-43ff-a152-bb1b9744ee8b"
}
}
https://faceid.intl.tencentcloudapi.com/?Action=PhoneVerification
&IdCard=11204416541220243X
&Name=韦小宝
&Phone=16137688175
&<公共请求参数>
{
"Response": {
"Description": "信息不一致",
"Isp": "联通",
"RequestId": "884a35af-289f-4b4e-a0b3-2315f02ab31e",
"Result": "-4"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportEncryptField | 存在不加密的字段,请参考文档修改。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.ChargeStatusException | 计费状态异常。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
文档反馈