文档中心
API调试

功能描述

往来港澳通行证/往来台湾通行证

请求URL

https://api.textin.com/robot/v1.0/api/hk_mac_exit_entry_permit

HTTP请求方法

HTTP POST

请求头说明(Request Header)

请在HTTP请求中添加以下自定义Header。

header 名
x-ti-app-id 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id
x-ti-secret-code 请登录后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code

请求体说明(Request Body)

Content-Type: application/octet-stream

要上传的图片,目前支持jpg, png, bmp, pdf, tiff, 单帧gif等大部分格式.

请注意,请求体的数据格式为文件的二进制流,非 FormData 或其他格式。文件大小不超过 10M,图像宽高须介于 20 和 10000(像素)之间。

响应体说明(Response Data)

Content-Type: application/json

JSON结构说明如下:

字段名 描述
code 错误码,详见“错误码说明”
message 状态说明
result 结果信息
+ image_angle 图片的旋转角度,指原图需要经过顺时针旋转多少度,才能得到正方向的图片
+ rotated_image_width 旋转后图片宽度
+ rotated_image_height 旋转后图片高度
+ type 当前识别证件类型
+ item_list 识别结果
++ key 识别字段类型
++ value 识别字段结果
++ description 识别字段描述
++ position 识别的value在原图中的坐标,是个长度为8的数组 [0,1,2,3,4,5,6,7],(0, 1) 左上角坐标,(2, 3) 右上角坐标,(4, 5) 左下角坐标,(6, 7) 右下角坐标

item_list 中识别字段的说明

字段名 描述
card_number 证件号
issue_agency 签发机关
name 姓名
name_pinyin 姓名(汉语拼音)
gender 性别
birth_date 出生日期
card_valid_period 有效期限
issue_place 签发地点

错误码说明

错误码 描述
40101 x-ti-app-id 或 x-ti-secret-code 为空
40102 x-ti-app-id 或 x-ti-secret-code 无效,验证失败
40103 客户端IP不在白名单
40003 余额不足,请充值后再使用
40004 参数错误,请查看技术文档,检查传参
40007 机器人不存在或未发布
40008 机器人未开通,请至市场开通后重试
40301 图片类型不支持
40302 上传文件大小不符,文件大小不超过 10M
40303 文件类型不支持
40304 图片尺寸不符,图像宽高须介于 20 和 10000(像素)之间
40305 识别文件未上传
30203 基础服务故障,请稍后重试
500 服务器内部错误
官方社群
体验中心

联系我们