功能描述

护照识别

请求URL

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

HTTP请求方法（Method）

HTTP POST

请求头说明（Request Headers）

请在HTTP请求中添加以下自定义标头（Header）。

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

URL参数（Parameters）

URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头，不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2

参数名	数据类型	是否必填	允许的值	描述
head_portrait	string	否	1, 0	是否返回头像切图base64码，1为是，0为否, 默认为1
crop_image	integer	否	1, 0	是否返回整图切边base64码，1为是，0为否，默认为1

请求体说明（Request Body）

Content-Type: application/octet-stream

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

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

响应体说明（Response）

Content-Type: application/json

JSON结构说明如下：

字段名	类型	描述
code	integer	错误码，详见“错误码说明”
message	string	错误信息
result	object
+ type	string	当前识别证件类型，当为other的时候,代表无法识别的图片 passport:护照 other:其他
+ rotated_image_width	integer	正方向时图片的宽
+ rotated_image_height	integer	正方向时图片高
+ image_angle	integer	图片顺时针旋转角度
+ item_list	array	表格常规结构化结果
++ key	string	护照结构化结果字段名 passport_number: 护照号码 country_code: 国家码 sex: 性别 pinyin: 拼音 name: 姓名 birthday: 出生日期 validity: 有效期 passport_nation: 国籍 issue_date: 签发日期 birthplace: 出生地点 issue_place: 签发地点 passport_line1: 护照下方第一行 passport_line2: 护照下方第二行 issued_by: 签发机关 surname: 姓 given_name: 名 crop_image: 切边图像 head_portrait: 头像切边
++ value	string	结构化结果的字段的值
++ position	array	识别的字段在旋转后图中的坐标, 是个长度为8的数组 [0,1,2,3,4,5,6,7] (0, 1) 左上角坐标 (2, 3) 右上角坐标 (4, 5) 右下角坐标 (6, 7) 左下角坐标
++ description	string	结构化识别字段的中文描述

JSON结构示例

{
    "code": 200,
    "message": "success",
    "result": {
        "type": "passport",
        "rotated_image_width": 1184,
        "rotated_image_height": 817,
        "image_angle": 270,
        "item_list": [
            {
                "key": "name",
                "value": "张三",
                "position": [
                    242,
                    407,
                    435,
                    410,
                    435,
                    423,
                    242,
                    421
                ],
                "description": "姓名"
            }
        ]
    }
}

错误码说明

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