护照识别(免费公测版)

最近更新时间:2019-09-06 12:13:13

1. 接口描述

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

本接口支持中国大陆护照、中国香港护照、泰国护照及其他国外护照个人资料页多个字段的检测与识别。其中中国大陆居民护照识别,已支持字段包括英文姓名、中文姓名、国家码、护照号、出生地、出生日期、国籍英文、性别英文、有效期、签发地点英文、签发日期、持证人签名、护照机读码(MRZ码)等。中国香港护照、泰国护照及其他国外护照识别,已支持字段包括英文姓名、国籍、签发日期、性别、护照号码等。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PassportOCR
Version String 公共参数,本接口取值:2018-11-19
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto
ImageBase64 String 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
Type String 护照类型(默认CN):
CN:支持中国大陆居民护照,字段较多,精度更高;
HK:支持中国香港护照(部分主要字段);
GENERAL:支持国外护照(部分主要字段);
THAI:支持泰国护照(部分主要字段)。

3. 输出参数

参数名称 类型 描述
Country String 国家码
PassportNo String 护照号
Sex String 性别
Nationality String 国籍
BirthDate String 出生日期
BirthPlace String 出生地点
IssueDate String 签发日期
IssuePlace String 签发地点
ExpiryDate String 有效期
Signature String 持证人签名
CodeSet String 最下方第一行 MRZ Code 序列
CodeCrc String 最下方第二行 MRZ Code 序列
Name String 姓名
FamilyName String
FirstName String
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 护照识别示例代码

以中国大陆居民护照为例

输入示例

https://ocr.tencentcloudapi.com/?Action=PassportOCR
&ImageUrl=https://xx/a.jpg
&Type=CN
&<公共请求参数>

输出示例

{
  "Response": {
    "Country": "CHN",
    "PassportNo": "G12345678",
    "Sex": "M",
    "Nationality": "CHN",
    "BirthDate": "19920922",
    "BirthPlace": "SHANGHAI",
    "IssueDate": "20100820",
    "IssuePlace": "SHANGHAI",
    "ExpiryDate": "20200819",
    "Signature": "",
    "CodeSet": "POCHNZHANG<<SAN<<<<<<<<<<<<<<<<<<<<<<<<<<<<<",
    "CodeCrc": "G123456785CHN9209220M200819219203100<<<<<<60",
    "Name": "张三",
    "FamilyName": "ZHANG",
    "FirstName": "SAN",
    "RequestId": "39cce0fc-77b1-4271-82ae-9f0bf1036906"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.OcrFailed Ocr识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameter.EngineImageDecodeFailed 图片解码失败。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。