注册
文档中心
API调试

功能描述

港澳居民来往内地通行证

请求URL

https://api.textin.com/robot/v1.0/api/hk_mac_mainland_travel_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

URL参数

参数名 数据类型 是否必填 允许的值 描述
head_portrait integer 1, 0

是否返回头像切图(jpg的base64码),1为是,0为否, 默认为0

请求体说明(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 integer 错误码,详见“错误码说明”
message string

错误信息

duration integer

响应时间

result object
+ type string

证件类型, 当为other的时候,代表无法识别的图片 - twn_mainland_travel_permit:回乡证

+ rotated_image_width integer

正方向时图片的宽

+ rotated_image_height integer

正方向时图片高

+ image_angle integer

图片角度,指原图需要经过顺时针旋转多少度,才能得到正方向的图片

+ item_list array
   ++ description string

识别的字段的描述

   ++ key string

结构化结果的字段名

  • name : 姓名
  • name_pinyin : 姓名(拼音)
  • birth_date : 出生日期
  • gender : 性别
  • card_valid_period : 有效日期
  • issue_agency : 签发机关
  • issued_place : 签发地址
  • certificates_number : 证件号码
  • issued_frequency : 签发次数
  • head_portrait:头像切图(jpg的base64码)
   ++ value string

识别的字段的值

   ++ position array

识别的value在原图中的坐标是个长度为8的数组 [0,1,2,3,4,5,6,7]

  • (0, 1) 左上角坐标
  • (2, 3) 右上角坐标
  • (4, 5) 右下角坐标
  • (6, 7) 左下角坐标

JSON结构示例

{
    "code": 200,
    "message": "success",
    "duration": 100,
    "result": {
        "type": "twn_mainland_travel_permit",
        "rotated_image_width": 1184,
        "rotated_image_height": 817,
        "image_angle": 270,
        "item_list": [
            {
                "description": "识别的字段的描述",
                "key": "name",
                "value": "识别的字段的值",
                "position": [
                    100,
                    200,
                    200,
                    200,
                    300,
                    200,
                    100,
                    300
                ]
            }
        ]
    }
}

错误码说明

错误码 描述
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 服务器内部错误
体验中心

联系我们