1. 接口描述
接口请求域名: faceid.tencentcloudapi.com 。
传入身份证人像面照片,识别身份证照片上的信息,并将姓名、身份证号、身份证人像照片与权威库的证件照进行比对,是否属于同一个人,从而验证身份证信息的真实性。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CheckIdCardInformation。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ImageBase64 | 否 | String | 身份证人像面的 Base64 值 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。 ImageBase64、ImageUrl二者必须提供其中之一。若都提供了,则按照ImageUrl>ImageBase64的优先级使用参数。 示例值:"" |
ImageUrl | 否 | String | 身份证人像面的 Url 地址 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。 示例值:"" |
Config | 否 | String | 以下可选字段均为bool 类型,默认false: CopyWarn,复印件告警 BorderCheckWarn,边框和框内遮挡告警 ReshootWarn,翻拍告警 DetectPsWarn,PS检测告警(疑似存在PS痕迹) TempIdWarn,临时身份证告警 Quality,图片质量告警(评价图片模糊程度) SDK 设置方式参考: Config = Json.stringify({"CopyWarn":true,"ReshootWarn":true}) API 3.0 Explorer 设置方式参考: Config = {"CopyWarn":true,"ReshootWarn":true} |
IsEncrypt | 否 | Boolean | 是否需要对返回中的敏感信息进行加密。默认false。 其中敏感信息包括:Response.IdNum、Response.Name 示例值:false |
IsEncryptResponse | 否 | Boolean | 是否需要对响应体加密 示例值:false |
Encryption | 否 | Encryption | 是否需要对返回中的敏感信息进行加密,需指定加密算法Algorithm、CBC加密的初始向量、加密后的对称密钥。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Sim | Float | 相似度,取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人,可根据具体场景自行调整阈值(阈值70的误通过率为千分之一,阈值80的误通过率是万分之一) 示例值:98.819999694824 |
Result | String | 业务错误码,成功情况返回Success, 错误情况请参考下方错误码 列表中FailedOperation部分 示例值:FailedOperation.OcrWarningOccurred |
Description | String | 业务结果描述。 示例值:成功 |
Name | String | 姓名 示例值:洪** |
Sex | String | 性别 示例值:男 |
Nation | String | 民族 示例值:汉 |
Birth | String | 出生日期 示例值:1995/8/6 |
Address | String | 地址 示例值:广东省xxxxxxxxxxxx |
IdNum | String | 身份证号 示例值:xxxxxxx |
Portrait | String | 身份证头像照片的base64编码,如果抠图失败会拿整张身份证做比对并返回空。 示例值:zok/tK7k2bLjyJE |
Warnings | String | 告警信息,当在Config中配置了告警信息会停止人像比对,Result返回错误(FailedOperation.OcrWarningOccurred)并有此告警信息,Code 告警码列表和释义: -9101 身份证边框不完整告警, -9102 身份证复印件告警, -9103 身份证翻拍告警, -9105 身份证框内遮挡告警, -9104 临时身份证告警, -9106 身份证 PS 告警(疑似存在PS痕迹)。 -8001 图片模糊告警 多个会 | 隔开如 "-9101|-9106|-9104" 示例值:-9101|-9106|-9104 |
Quality | Float | 图片质量分数,当请求Config中配置图片模糊告警该参数才有意义,取值范围(0~100),目前默认阈值是50分,低于50分会触发模糊告警。 示例值:0 |
Encryption | Encryption | 敏感数据加密信息。 注意:此字段可能返回 null,表示取不到有效值。 |
EncryptedBody | String | 加密后的数据 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 使用身份证照片Base64进行验证
输入示例
https://faceid.tencentcloudapi.com/?Action=CheckIdCardInformation
&ImageBase64=<base64字符串>
&Config={"CopyWarn":true}
&<公共请求参数>
输出示例
{
"Response": {
"Address": "广东省xxxxxxxxxxxx",
"Birth": "1995/8/6",
"Description": "成功",
"IdNum": "xxxxxxx",
"Name": "洪**",
"Nation": "汉",
"RequestId": "eb10******579b9a",
"Result": "FailedOperation.OcrWarningOccurred",
"Sex": "男",
"Sim": 98.819999694824,
"Portrait": "zok/tK7k2bLjyJE",
"Warnings": "-9101|-9106|-9104",
"Quality": 0.0,
"Encryption": {
"Iv": "abc",
"EncryptList": [
"IdName"
],
"CiphertextBlob": "abc"
}
}
}
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.CompareLowSimilarity | 比对相似度未达到通过标准。 |
FailedOperation.CompareSystemError | 调用比对引擎接口出错。 |
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.EmptyImageError | 图片内容为空。 |
FailedOperation.EncryptSystemError | 加密失败。 |
FailedOperation.FileSaveError | 文件存储失败,请稍后重试。 |
FailedOperation.IdFormatError | 输入的身份证号有误。 |
FailedOperation.IdNameMisMatch | 姓名和身份证号不一致,请核实后重试。 |
FailedOperation.IdNoExistSystem | 库中无此号,请到户籍所在地进行核实。 |
FailedOperation.IdPhotoNoExist | 库中无此号照片,请到户籍所在地进行核实。 |
FailedOperation.IdPhotoPoorQuality | 证件图片质量差,请更新后重试。 |
FailedOperation.IdPhotoSystemNoanswer | 客户库自建库或认证中心返照失败,请稍后再试。 |
FailedOperation.ImageBlur | 图片模糊。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageNoIdCard | 图片中未检测到身份证。 |
FailedOperation.ImageSizeTooLarge | 图片尺寸过大。 |
FailedOperation.LifePhotoDetectFaces | 检测到多张人脸。 |
FailedOperation.LifePhotoDetectFake | 实人比对没通过。 |
FailedOperation.LifePhotoDetectNoFaces | 未能检测到完整人脸。 |
FailedOperation.LifePhotoPoorQuality | 传入图片分辨率太低,请重新上传。 |
FailedOperation.LifePhotoSizeError | 传入图片过大或过小。 |
FailedOperation.OcrFailed | Ocr识别失败。 |
FailedOperation.RequestLimitExceeded | 调用次数超出限制。 |
FailedOperation.StsUnAuthErrError | STS未授权。 |
FailedOperation.UnKnown | 内部未知错误。 |
InternalError.EncryptSystemError | 加密失败。 |
InternalError.UnKnown | 内部未知错误。 |
InvalidParameter | 参数错误。 |
UnauthorizedOperation.Arrears | 账号已欠费。 |
UnauthorizedOperation.ChargeStatusException | 计费状态异常。 |
UnauthorizedOperation.Nonactivated | 未开通服务。 |