有效身份证件识别(鉴伪版)

最近更新时间:2024-11-11 01:54:47

我的收藏

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口支持二代身份证、临时身份证、港澳台居住证、外国人永久居留证,字段内容识别功能,包括姓名、性别、民族、出生、出生日期、住址、公民身份号码、签发机关、有效期限、国籍、通行证号码、持证人持有号码;支持返回证件类型;支持翻拍、复印、边框不完整、遮挡、字段级反光和字段级完整性告警;支持卡片主体框裁剪和头像裁剪。

默认接口请求频率限制:20次/秒。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RecognizeValidIDCardOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
ImageBase64 String 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
建议图片存储于腾讯云,可保障更高的下载速度和稳定性。
示例值:https://xx/a.jpg
CardType Integer 0 自动,自动判断输入证件的类型
1 身份证人像面,指定输入证件类型为二代身份证人像面
2 身份证国徽面,指定输入证件类型为二代身份证国徽面
3 身份证人像国徽面,指定输入证件类型为二代身份证人像面或者国徽面
4 临时身份证人像面,指定输入证件类型为临时身份证人像面
5 临时身份证国徽面,指定输入证件类型为临时身份证国徽面
6 临时身份证人像国徽面,指定输入证件类型为临时身份证人像面或者国徽面
7 港澳台居住证人像面,指定输入证件类型为港澳台居住证人像面
8 港澳台居住证国徽面,指定输入证件类型为港澳台居住证国徽面
9 港澳台居住证人像国徽面,指定输入证件类型为港澳台居住证人像面或者国徽面
10 外国人永久居留身份证人像面,指定输入证件类型为外国人永久居留证人像面
11 外国人永久居留身份证国徽面,指定输入证件类型为外国人永久居留证国徽面
12 外国人永久居留身份证人像国徽面,指定输入证件类型为外国人永久居留证人像或者国徽面
该参数如果不填,将为您自动判断卡证类型。
示例值:0
EnablePortrait Boolean 默认值为false,打开返回证件头像切图。
示例值:false
EnableCropImage Boolean 默认值为false,打开返回证件主体切图。
示例值:false
EnableBorderCheck Boolean 默认值为false,打开返回边缘完整性判断。
示例值:false
EnableOcclusionCheck Boolean 默认值为false,打开返回证件是否被遮挡。
示例值:false
EnableCopyCheck Boolean 默认值为false,打开返回证件是否存在复印。
示例值:false
EnableReshootCheck Boolean 默认值为false,打开返回证件是否存在屏幕翻拍。
示例值:false
EnablePSCheck Boolean 默认值为false,打开返回证件是否存在PS。类型为:临时、港澳台居住证、外国人居住证失效
示例值:false
EnableWordCheck Boolean 默认值为false,打开返回字段级反光和字段级完整性告警。类型为:临时、港澳台居住证、外国人居住证失效
示例值:false

3. 输出参数

参数名称 类型 描述
Type String 卡证类型
身份证人像面
身份证国徽面

临时身份证人像面
临时身份证人像面

港澳台居住证人像面
港澳台居住证国徽面

外国人永久居留证人像面
外国人永久居留证国徽面
IDCardInfo IDCardInfo 身份证信息
注意:此字段可能返回 null,表示取不到有效值。
TemporaryIDCardInfo TemporaryIDCardInfo 临时身份证信息
注意:此字段可能返回 null,表示取不到有效值。
ResidencePermitInfo ResidencePermitInfo 港澳台居住证信息
注意:此字段可能返回 null,表示取不到有效值。
PermanentResidencePermitInfo PermanentResidencePermitInfo 外国人永久居留证信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 有效身份证件识别(鉴伪版)示例

识别身份证信息

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecognizeValidIDCardOCR
<公共请求参数>

{
    "ImageUrl": "https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/card/IDCardOCR/IDCardOCR1.jpg"
}

输出示例

{
    "Response": {
        "IDCardInfo": {
            "Address": {
                "Confidence": 89,
                "Content": "广东省深圳市南山区腾讯大厦",
                "IsInComplete": 0,
                "IsReflect": 0
            },
            "Authority": {
                "Confidence": 0,
                "Content": "",
                "IsInComplete": 1,
                "IsReflect": 0
            },
            "Birth": {
                "Confidence": 89,
                "Content": "1995年5月13日",
                "IsInComplete": 0,
                "IsReflect": 0
            },
            "CardImage": {
                "Confidence": 0,
                "Content": "",
                "IsInComplete": 1,
                "IsReflect": 0
            },
            "IdNum": {
                "Confidence": 89,
                "Content": "440305199505132561",
                "IsInComplete": 0,
                "IsReflect": 0
            },
            "Name": {
                "Confidence": 89,
                "Content": "刘洋",
                "IsInComplete": 0,
                "IsReflect": 0
            },
            "Nation": {
                "Confidence": 89,
                "Content": "汉",
                "IsInComplete": 0,
                "IsReflect": 0
            },
            "PortraitImage": {
                "Confidence": 0,
                "Content": "",
                "IsInComplete": 1,
                "IsReflect": 0
            },
            "Sex": {
                "Confidence": 89,
                "Content": "女",
                "IsInComplete": 0,
                "IsReflect": 0
            },
            "ValidDate": {
                "Confidence": 0,
                "Content": "",
                "IsInComplete": 1,
                "IsReflect": 0
            },
            "WarnInfos": {
                "BorderCheck": 0,
                "CopyCheck": 0,
                "OcclusionCheck": 0,
                "PSCheck": 0,
                "ReshootCheck": 0
            }
        },
        "PermanentResidencePermitInfo": null,
        "RequestId": "531e2077-4fc0-4245-9114-526a752f71a8",
        "ResidencePermitInfo": null,
        "TemporaryIDCardInfo": null,
        "Type": "身份证人像面"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.CardSideError 身份证CardSide类型错误
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.IdCardInfoIllegal 第二代身份证信息不合法或缺失(身份证号、姓名字段校验非法等)
FailedOperation.IdCardTooSmall 图片分辨率过小或身份证在原图中的占比过小
FailedOperation.ImageBlur 图片模糊。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoIdCard 图片中未检测到第二代身份证或临时身份证。
FailedOperation.ImageSizeTooLarge 图片尺寸过大,请参考输入参数中关于图片大小限制的说明。
FailedOperation.MultiCardError 图片中存在两张及以上同面卡证,请上传卡证单面图片或一正一反双面图片。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameter.ConfigFormatError Config不是有效的JSON格式。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourceUnavailable.InArrears 账号已欠费。
ResourceUnavailable.ResourcePackageRunOut 账号资源包耗尽。
ResourcesSoldOut.ChargeStatusException 计费状态异常。