文档中心
API调试

功能描述

户口本

请求URL

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

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

错误信息

result object
+type string

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

+image_angle integer

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

+rotated_image_width integer

正方向时图片的宽

+rotated_image_height integer

正方向时图片高

+item_list array
   ++key string

识别的字段

   ++value string

识别的字段的值

   ++description string

识别的字段中文描述

   ++position array

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

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

item_list 中识别字段的说明

字段名 描述
member_name 姓名
member_householder_or_relationship_with_householder 户主或与户主关系
member_used_name 曾用名
member_sex 性别
member_birthplace 出生地
member_nationality 民族
member_origin_place 籍贯
member_birth 出生日期
member_other_address_this_city 本市(县)其他住址
member_religion 宗教信仰
member_id_number 身份证号码
member_height 身高
member_blood_type 血型
member_education_background 文化程度
member_marital_status 婚姻状况
member_military_service_status 兵役状况
member_unit_of_service 服务处所
member_profession 职业
member_when_and_where_to_move_to_this_city 何时由何地迁来本市(县)
member_when_and_where_to_move_to_this_site 何时由何地迁来本址
member_registration_date 登记日期
household_residence_type 户别
household_householder_name 户主姓名
household_address 住址
household_residence_number 户号
household_date 签发日期
subtype 子类型
type 证件类型

JSON结构示例

{"code":200,"message":"success","result":{"type":"","item_list":[{"key":""}]}}

错误码说明

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

联系我们