文档简介:
接口描述
支持识别4类港澳台出入境证件,包含港澳通行证正/反面、台湾通行证正/反面、台胞证(台湾居民来往大陆通行证)正/反面、返乡证(港澳居民来往内地通行证)正/反面,支持识别以上4类证件的全部字段信息。
在线调试
您可以在 示例代码中心 中调试该接口,可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求说明
请求示例
HTTP 方法:POST
请求URL: https://aip.baidubce.com/rest/2.0/ocr/v1/hk_macau_taiwan_exitentrypermit
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
image | 和 url/pdf_file 三选一 | string | - |
图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效 |
url | 和 image/pdf_file 三选一 | string | - |
图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 优先级:image > url > pdf_file,当image字段存在时,url字段失效 请注意关闭URL防盗链 |
pdf_file | 和 image/url 三选一 | string | - |
PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px 优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效 |
pdf_file_num | 否 | string | - | 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页 |
exitentrypermit_type | 是 | string |
hk_mc_passport_front:港澳通行证正面 hk_mc_passport_back:港澳通行证反面 tw_passport_front:台湾通行证正面 tw_passport_back:台湾通行证反面 tw_return_passport_front:台胞证正面 tw_return_passport_back:台胞证反面 hk_mc_return_passport_front:返乡证正面 hk_mc_return_passport_back:返乡证反面 |
出入境许可证件的具体类型 |
probability | 否 | string | true/false | 是否返回字段置信度,默认为 false ,即不返回 |
location | 否 | string | true/false | 是否返回字段位置坐标,默认为 false,即不返回 |
请求代码示例
提示一:使用示例代码前,请记得替换其中的示例Token、图片地址或Base64信息。
提示二:部分语言依赖的类或库,请在代码注释中查看下载地址。
curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/hk_macau_taiwan_exitentrypermit?access
_token=【调用鉴权接口获取的token】' --data 'image=【图片Base64编码,需UrlEncode】
&exitentrypermit_type=tw_return_passport_front' -H 'Content-Type:application/x-www-form-urlencoded'
返回说明
返回参数
1、港澳通行证正面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ card_number | 是 | array[] | 证件号码 |
+ name_chn | 是 | array[] | 姓名 |
+ name_eng | 是 | array[] | 姓名(英文) |
+ birthday | 是 | array[] | 出生日期 |
+ sex | 是 | array[] | 性别 |
+ valid_date | 是 | array[] | 有效期限 |
+ issue_authority | 是 | array[] | 签发机关 |
+ issue_place | 是 | array[] | 签发地点 |
+ MRZCode | 是 | array[] | 证件下方第一行 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
2、港澳通行证反面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ hk_type | 是 | array[] | 来往香港签注-种类 |
+ hk_valid_date | 是 | array[] | 来往香港签注-有效期 |
+ hk_remarks | 是 | array[] | 来往香港签注-备注 |
+ hk_round_trip_number | 是 | array[] | 来往香港签注-往返有效 |
+ mc_type | 是 | array[] | 来往澳门签注-种类 |
+ mc_valid_date | 是 | array[] | 来往澳门签注-有效期 |
+ mc_remarks | 是 | array[] | 来往澳门签注-备注 |
+ mc_round_trip_number | 是 | array[] | 来往澳门签注-往返有效 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
3、台湾通行证正面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ card_number | 是 | array[] | 证件号码 |
+ name_chn | 是 | array[] | 姓名 |
+ name_eng | 是 | array[] | 姓名(英文) |
+ birthday | 是 | array[] | 出生日期 |
+ sex | 是 | array[] | 性别 |
+ valid_date | 是 | array[] | 有效期限 |
+ issue_authority | 是 | array[] | 签发机关 |
+ issue_place | 是 | array[] | 签发地点 |
+ MRZCode | 是 | array[] | 证件下方第一行 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
4、台湾通行证反面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ type | 是 | array[] | 种类 |
+ valid_date | 是 | array[] | 有效期 |
+ remarks | 是 | array[] | 备注 |
+ round_trip_number | 是 | array[] | 往返有效 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
5、返乡证正面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ name_chn | 是 | array[] | 姓名 |
+ name_eng | 是 | array[] | 姓名(英文) |
+ birthday | 是 | array[] | 出生日期 |
+ sex | 是 | array[] | 性别 |
+ valid_date | 是 | array[] | 有效期限 |
+ issue_authority | 是 | array[] | 签发机关 |
+ issue_times | 是 | array[] | 签发次数 |
+ card_number | 是 | array[] | 证件号码 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
6、返乡证反面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ idcard_name | 是 | array[] | 身份证姓名 |
+ idcard_number | 是 | array[] | 身份证号码 |
+ MRZCode1 | 是 | array[] | 证件下方第一行 |
+ MRZCode2 | 是 | array[] | 证件下方第二行 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
7、台胞证正面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ name_chn | 是 | array[] | 姓名 |
+ name_eng | 是 | array[] | 姓名(英文) |
+ birthday | 是 | array[] | 出生日期 |
+ sex | 是 | array[] | 性别 |
+ valid_date | 是 | array[] | 有效期限 |
+ issue_authority | 是 | array[] | 签发机关 |
+ issue_place | 是 | array[] | 签发地点 |
+ card_number | 是 | array[] | 证件号码 |
+ issue_times | 是 | array[] | 签发次数 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
8、台胞证反面
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ idcard_name | 是 | array[] | 身份证姓名 |
+ idcard_number | 是 | array[] | 身份证号码 |
+ MRZCode1 | 是 | array[] | 证件下方第一行 |
+ MRZCode2 | 是 | array[] | 证件下方第二行 |
++ word | 是 | string | 字段识别结果,以上字段均包含 |
++ location | 否 | object{} | 字段位置信息,当请求参数 location=true 时返回该字段,以上字段均包含 |
+++ top | 否 | uint32 | 字段的上边距 |
+++ left | 否 | uint32 | 字段的左边距 |
+++ height | 否 | uint32 | 字段的高度 |
+++ width | 否 | uint32 | 字段的宽度 |
++ probability | 否 | object{} | 字段识别结果置信度,当请求参数 probability=true 时返回该字段,以上字段均包含 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
返回示例
示例一:港澳通行证正面
{ "words_result_num": 9, "words_result": { "card_number": [ { "word": "C00000000" } ],
"name_chn": [ { "word": "证件样本" } ], "name_eng": [ { "word": "ZHENGJIAN,YANGBEN" } ],
"birthday": [ { "word": "1981.08.03" } ], "sex": [ { "word": "女" } ], "valid_date": [
{ "word": "2014.04.21-2024.04.20" } ], "issue_authority": [ { "word": "公安部出入境管理局" }
], "issue_place": [ { "word": "广东" } ], "MRZCode": [ { "word": "CSC000000004<24042
00<8108038<6" } ] }, "direction": 0, "log_id": 1645241609425709013 }