1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
传入照片和身份信息，判断该照片与权威库的证件照是否属于同一个人。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ImageRecognitionV2。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| IdCard | 是 | String | 身份证号 示例值：11204416541220243X |
| Name | 是 | String | 姓名。中文请使用UTF-8编码。 示例值：韦小宝 |
| ImageBase64 | 是 | String | 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。 示例值： |
| Optional | 否 | String | 本接口不需要传递此参数。 |
| Encryption | 否 | Encryption | 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Sim | Float | 相似度，取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人，可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一） 示例值：89.88 |
| Result | String | 业务错误码，成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分 示例值：Success |
| Description | String | 业务结果描述。 示例值：成功 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 照片人脸核身 前往调试工具
输入示例
https://faceid.tencentcloudapi.com/?Action=ImageRecognitionV2
&IdCard=11204416541220243X
&Name=韦小宝
&ImageBase64=<ImageBase64>
&<公共请求参数>输出示例
{
"Response": {
"Result": "Success",
"Description": "成功",
"Sim": 89.88,
"RequestId": "f904f4cf-75db-4f8f-a5ec-dc4f942c7f7a"
}
}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.CompareFail | 比对失败。 |
| FailedOperation.CompareLibServiceUnavailable | 比对库源维护中，暂时不可用 |
| FailedOperation.CompareLowSimilarity | 比对相似度未达到通过标准。 |
| FailedOperation.CompareSystemError | 调用比对引擎接口出错。 |
| FailedOperation.DecryptSystemError | 解密失败。 |
| FailedOperation.IdFormatError | 输入的身份证号有误。 |
| FailedOperation.IdNameMisMatch | 姓名和身份证号不一致，请核实后重试。 |
| FailedOperation.IdNoExistSystem | 库中无此号，请到户籍所在地进行核实。 |
| FailedOperation.IdPhotoNoExist | 库中无此号照片，请到户籍所在地进行核实。 |
| FailedOperation.IdPhotoPoorQuality | 证件图片质量差，请更新后重试。 |
| FailedOperation.IdPhotoSystemNoanswer | 客户库自建库或认证中心返照失败，请稍后再试。 |
| FailedOperation.IdentityAuthLimitExceeded | 身份认证次数超限。默认：同一身份证号，1分钟15次，1天30次。如需提高限频，请联系慧眼小助手。 |
| FailedOperation.LifePhotoDetectFaces | 检测到多张人脸。 |
| FailedOperation.LifePhotoDetectFake | 实人比对没通过。 |
| FailedOperation.LifePhotoDetectNoFaces | 未能检测到完整人脸。 |
| FailedOperation.LifePhotoPoorQuality | 传入图片分辨率太低，请重新上传。 |
| FailedOperation.LifePhotoSizeError | 传入图片过大或过小。 |
| FailedOperation.NameFormatError | 输入的姓名有误。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportEncryptField | 存在不加密的字段，请参考文档修改。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
| UnsupportedOperation | 操作不支持。 |