1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
本接口用于校验手机号、姓名和身份证号的真实性和一致性，入参支持明文、MD5和SHA256加密传输。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：EncryptedPhoneVerification。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| IdCard | 是 | String | 身份证号，加密方式以EncryptionMode为准 示例值：21b2ad431ee1f6d32c3f54c23c687751 |
| Name | 是 | String | 姓名，加密方式以EncryptionMode为准 示例值：615db57aa314529aaa0fbe95b3e95bd3 |
| Phone | 是 | String | 手机号，加密方式以EncryptionMode为准 示例值：18c6f9a0ca21c6bc9c58675adfc4196e |
| EncryptionMode | 是 | String | 敏感信息的加密方式，目前支持明文、MD5和SHA256加密传输，参数取值： 0：明文，不加密 1：使用MD5加密 2：使用SHA256 3：使用SM3加密 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 认证结果码: 【收费结果码】 0: 三要素信息一致 -4: 三要素信息不一致 【不收费结果码】 -7: 身份证号码有误 -8: 参数错误 -9: 没有记录 -11: 验证中心服务繁忙 示例值：0 |
| Description | String | 业务结果描述。 示例值：认证通过 |
| ISP | String | 运营商名称。 取值范围为["移动","联通","电信",""] 示例值：运营商 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 认证通过示例
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EncryptedPhoneVerification
<公共请求参数>
{
"Phone": "18c6f9a0ca21c6bc9c58675adfc4196e",
"IdCard": "21b2ad431ee1f6d32c3f54c23c684751",
"EncryptionMode": "1",
"Name": "615db57aa314529aaa0fbe95b3e95bd3"
}输出示例
{
"Response": {
"Result": "0",
"Description": "认证通过",
"ISP": "联通",
"RequestId": "a5fdb909-5ee6-43ff-a152-bb1b9744ee8b"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportEncryptField | 存在不加密的字段，请参考文档修改。 |
| InvalidParameterValue | 参数取值错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.ChargeStatusException | 计费状态异常。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
