接口请求域名： faceid.intl.tencentcloudapi.com 。
传入身份证人像面照片，识别身份证照片上的信息，并将姓名、身份证号、身份证人像照片与权威库的证件照进行比对，是否属于同一个人，从而验证身份证信息的真实性。
默认接口请求频率限制：100次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CheckIdCardInformation。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ImageBase64 | 否 | String | 身份证人像面的 Base64 值。
|
| ImageUrl | 否 | String | 身份证人像面的 Url 地址
|
| Config | 否 | String | 配置。
|
| IsEncrypt | 否 | Boolean | 是否需要对返回中的敏感信息进行加密。
|
| IsEncryptResponse | 否 | Boolean | 是否需要对响应体加密。 |
| Encryption | 否 | Encryption | 是否需要对返回中的敏感信息进行加密,需指定加密算法Algorithm、CBC加密的初始向量、加密后的对称密钥。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Sim | Float | 相似度。- 取值范围 [0.00, 100.00]。- 推荐相似度大于等于70时可判断为同一人（采用固定阈值70，误通过率为万分之一，不支持调整阈值）。 |
| Result | String | 业务错误码。- 成功情况返回Success。- 错误情况请参考下方错误码 列表中FailedOperation部分 |
| Description | String | 业务结果描述。 |
| Name | String | 姓名。 |
| Sex | String | 性别。 |
| Nation | String | 民族。 |
| Birth | String | 出生日期。 |
| Address | String | 地址。 |
| IdNum | String | 身份证号。 |
| Portrait | String | 身份证头像照片的base64编码，如果抠图失败会拿整张身份证做比对并返回空。 |
| Warnings | String | 告警信息。
|
| Quality | Float | 图片质量分数。
|
| Encryption | Encryption | 敏感数据加密信息。 注意：此字段可能返回 null，表示取不到有效值。 |
| EncryptedBody | String | 加密后的数据。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
https://faceid.intl.tencentcloudapi.com/?Action=CheckIdCardInformation
&ImageBase64=/9j/4AAQSkZJRg.....s97n//2Q==
&Config={"CopyWarn":true}
&<公共请求参数>
{
"Response": {
"Address": "北京市东城区景山前街4号紫禁城敬事房",
"Birth": "1654/12/20",
"Description": "出现OCR告警",
"IdNum": "11204416541220243X",
"Name": "韦小宝",
"Nation": "满",
"Portrait": "/9j/4AAQSk...Se/wDkf//Z",
"Quality": 99,
"Encryption": null,
"RequestId": "6e6cfaad-3271-4eb1-a203-2866100eb283",
"Result": "FailedOperation.OcrWarningOccurred",
"Sex": "男",
"Sim": 0,
"Warnings": "-9101"
}
}
https://faceid.intl.tencentcloudapi.com/?Action=CheckIdCardInformation
&ImageBase64=/9j/4AAQSkZJRg.....s97n//2Q==
&Config={"CopyWarn":true}
&<公共请求参数>
{
"Response": {
"Address": "北京市东城区景山前街4号紫禁城敬事房",
"Birth": "1654/12/20",
"Description": "成功",
"Encryption": null,
"IdNum": "11204416541220243X",
"Name": "韦小宝",
"Nation": "汉",
"Portrait": "/9j/4AAQSk...m3Zt62P//Z",
"Quality": 98,
"RequestId": "8dc2b640-caad-4a13-ad8c-204d46d29fe1",
"Result": "Success",
"Sex": "男",
"Sim": 99.76,
"Warnings": ""
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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 | 未开通服务。 |
文档反馈