港澳台来往内地通行证识别

最近更新时间:2024-09-12 02:02:21

我的收藏

1. 接口描述

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

智能识别并结构化港澳台居民来往内地通行证正面全部字段,包含中文姓名、英文姓名、性别、出生日期、签发机关、有效期限、证件号、签发地点、签发次数、证件类别。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:MainlandPermitOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
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 速度和稳定性可能受一定影响。
示例值:https://xx/a.jpg
RetProfile Boolean 是否返回头像。默认不返回。
示例值:False
CardSide String 图片正反面
FRONT:正面、BACK:反面,默认为FRONT
示例值:FRONT

3. 输出参数

参数名称 类型 描述
Name String 中文姓名
示例值:李明
EnglishName String 英文姓名
示例值:LIMING
Sex String 性别
示例值:男
Birthday String 出生日期
示例值:1981.08.03
IssueAuthority String 签发机关
示例值:公安部出入境管理局
ValidDate String 有效期限
示例值:2018.10.09-2028.10.08
Number String 证件号
示例值:C00000000
IssueAddress String 签发地点
示例值:广东
IssueNumber String 签发次数
示例值:02
Type String 证件类别, 如:台湾居民来往大陆通行证、港澳居民来往内地通行证。
示例值:台湾居民来往大陆通行证
Profile String RetProfile为True时返回头像字段, Base64编码
Nationality String 国籍
MainlandTravelPermitBackInfos MainlandTravelPermitBackInfos 背面字段信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 港澳台来往内地通行证识别示例代码

港澳台来往内地通行证识别

输入示例

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

{
    "ImageUrl": "https://xx/a.jpg",
    "RetProfile": "False"
}

输出示例

{
    "Response": {
        "Name": "李明",
        "EnglishName": "LIMING",
        "Number": "C00000000",
        "Sex": "男",
        "ValidDate": "2018.10.09-2028.10.08",
        "IssueAuthority": "公安部出入境管理局",
        "IssueAddress": "广东",
        "Birthday": "1981.08.03",
        "IssueNumber": "02",
        "Type": "台湾居民来往大陆通行证",
        "Profile": "",
        "RequestId": "3090debe-3662-4ef1-8784-6ef2fb59f75e"
    }
}

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.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourceUnavailable.InArrears 帐号已欠费。
ResourcesSoldOut.ChargeStatusException 计费状态异常。