有奖:语音产品征文挑战赛等你来> HOT

1. 接口描述

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

本接口支持中国港澳台地区以及其他国家、地区的护照识别。识别字段包括护照ID、姓名、出生日期、性别、有效期、发行国、国籍、国家地区代码,具备护照人像照片的裁剪功能和翻拍、复印件告警功能。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:MLIDPassportOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-singapore 。
ImageBase64 String 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
示例值:base64编码
RetImage Boolean 是否返回图片,默认false
示例值:false
ImageUrl String 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。
建议图片存储于腾讯云,可保障更高的下载速度和稳定性。
示例值:https://xx/a.jpg

3. 输出参数

参数名称 类型 描述
ID String 护照ID(机读码区的解析结果)
示例值:E6918C
Name String 姓名(机读码区的解析结果)
示例值:BROWN BENJAMIN
DateOfBirth String 出生日期(机读码区的解析结果)
示例值:20230414
Sex String 性别(F女,M男)(机读码区的解析结果)
示例值:M
DateOfExpiration String 有效期(机读码区的解析结果)
示例值:20230414
IssuingCountry String 发行国(机读码区的解析结果)
示例值:SGP
Nationality String 国家地区代码(机读码区的解析结果)
示例值:SGP
Warn Array of Integer 告警码:
-9103 证照翻拍告警
-9102 证照复印件告警(包括黑白复印件、彩色复印件)
-9106 证件遮挡告警
示例值:[]
Image String 证件中的人像图片base64
AdvancedInfo String 扩展字段:
{
ID:{
Confidence:0.9999
},
Name:{
Confidence:0.9996
}
}
示例值:{"IssuingCountry":{"Confidence":"0.9500"},"Name":{"Confidence":"0.9500"},"ID":{"Confidence":"0.9500"},"Nationality":{"Confidence":"0.9500"},"Sex":{"Confidence":"0.9500"},"DateOfExpiration":{"Confidence":"0.9500"}}
CodeSet String 最下方第一行 MRZ Code 序列
示例值:P<CANBROWN<<BENJAMIN<<<<<<<<<<<<<<<<<<<<<<<<
CodeCrc String 最下方第二行 MRZ Code 序列
示例值:JK123488<3CAN8510168M2603298<<<<<<<<<<<<<<04
Surname String 姓(机读码区的解析结果)
注意:此字段可能返回 null,表示取不到有效值。
示例值:BROWN
GivenName String 名(机读码区的解析结果)
注意:此字段可能返回 null,表示取不到有效值。
示例值:BENJAMIN
Type String 类型(机读码区的解析结果)
PassportRecognizeInfos PassportRecognizeInfos 信息区证件内容
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 护照识别(港澳台地区及境外护照)示例代码前往调试工具

护照识别(港澳台地区及境外护照)

输入示例

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

{
    "ImageBase64": "base64编码"
}

输出示例

{
    "Response": {
        "AdvancedInfo": "{\"IssuingCountry\":{\"Confidence\":\"0.9500\"},\"Name\":{\"Confidence\":\"0.9500\"},\"ID\":{\"Confidence\":\"0.9500\"},\"Nationality\":{\"Confidence\":\"0.9500\"},\"DateOfBirth\":{\"Confidence\":\"0.9500\"},\"Sex\":{\"Confidence\":\"0.9500\"},\"DateOfExpiration\":{\"Confidence\":\"0.9500\"},\"Surname\":{\"Confidence\":\"0.9500\"},\"GivenName\":{\"Confidence\":\"0.9500\"},\"CodeSet\":{\"Confidence\":\"0.9995\"},\"CodeCrc\":{\"Confidence\":\"0.9997\"}}",
        "CodeCrc": "4567123452USA9004117F2107268713843748<708026",
        "CodeSet": "P<USACARTER<<ESTHER<<<<<<<<<<<<<<<<<<<<<<<<<",
        "DateOfBirth": "19900411",
        "DateOfExpiration": "20210726",
        "GivenName": "ESTHER",
        "ID": "456712345",
        "Image": "",
        "IssuingCountry": "USA",
        "Name": "CARTER ESTHER",
        "Nationality": "USA",
        "RequestId": "9c42cdcf-53df-445d-b45b-ea3eaaf2bb70",
        "Sex": "F",
        "Surname": "CARTER",
        "Type": "abc",
        "PassportRecognizeInfos": {
            "Type": "abc",
            "IssuingCountry": "abc",
            "PassportID": "abc",
            "Surname": "abc",
            "GivenName": "abc",
            "Name": "abc",
            "Nationality": "abc",
            "DateOfBirth": "abc",
            "Sex": "abc",
            "DateOfIssuance": "abc",
            "DateOfExpiration": "abc"
        },
        "Warn": [
            -9102
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.NoPassport 非护照。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourceUnavailable.InArrears 帐号已欠费。
ResourceUnavailable.ResourcePackageRunOut 账号资源包耗尽。
ResourcesSoldOut.ChargeStatusException 计费状态异常。