注册
文档中心
API调试

功能描述

台湾居民来往大陆通行证(台胞证)

请求URL

https://api.textin.com/ai/service/v1/taiwan_compatriot

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

错误信息

result object

图片结果信息

+ image_angle integer

图片顺时针旋转角度

+ rotated_image_width integer

旋转后图片宽度

+ rotated_image_height integer

旋转后图片高度

+ type string

当前识别证件类型,当为other的时候,代表无法识别的图片

  • taiwan_compatriot: 台湾居民往来大陆通行证(台胞证)
  • other:其他
+ item_list array

常规结构化结果

   ++ description string

结构化结果字段描述

   ++ value string

结构化结果字段的值

   ++ position array

识别的字段在旋转后图中的坐标, 是个长度为8的数组 [0,1,2,3,4,5,6,7]

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

结构化结果的字段名

  • name:姓名
  • name_pinyin:姓名拼音
  • birth_date:出生日期
  • gender:性别
  • card_valid_period:有效期
  • issue_agency:签发机关
  • issue_place:签发地点
  • certificates_number:证件号码
  • validate_date:有效期
  • issued_date:签发日期
  • issued_frequency:签发次数
  • address:地址
  • id_number:身份证号码
  • occupation:职业
  • the_bottom_line:底部第一行
  • card_type:证件种类
  • head_portrait:头像切图(jpg的base64码)

JSON结构示例

{
    "code": 200,
    "message": "success",
    "result": {
        "image_angle": 0,
        "rotated_image_width": 1920,
        "rotated_image_height": 1080,
        "type": "taiwan_compatriot",
        "item_list": [
            {
                "description": "结构化结果字段描述",
                "value": "结构化结果字段的值",
                "position": [
                    0,
                    0,
                    50,
                    0,
                    50,
                    30,
                    0,
                    30
                ],
                "key": "name"
            }
        ]
    },
    "duration": 100
}

错误码说明

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

联系我们