注册
文档中心
API调试

功能描述

身份证识别,返回文字,头像等证件内容

请求URL

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

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参数

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

是否检测黑白复印件,0为不检测,1为检测, 默认为1

img_info integer 1, 0

是否输出切边图片,0为不输出切边图片,1为输出切边图片,默认为1(已废弃,建议使用crop_image参数)

crop_image integer 1, 0

是否输出切边图片,0为不输出切边图片,1为输出切边图片,默认为1

expand integer 见描述

切边图像外扩幅度,幅度为0-100,默认为0,crop_image=1时有效

resize number 见描述

切图缩放比例,0~1之间,crop_image=1时有效

compression_rate integer 见描述

切图压缩率,0~100之间,crop_image=1时有效

round_image integer 1, 0

是否对切边图片做圆角处理,0为不做圆角处理,1为做圆角处理, 默认为0,crop_image=1时有效

head_portrait integer 1, 0

是否输出头像图片,0为不输出头像图片,1为输出头像图片,默认为1

head_portrait_expand_width number 见描述

头像图片宽度按比例外扩幅度,默认为0.5,当head_portrait=1时有效

head_portrait_expand_height number 见描述

头像图片高度按比例外扩幅度,默认为0.9,当head_portrait=1时有效

id_number_image integer 1, 0

是否输出身份证号码图片,0为不输出,1为输出,默认为1

is_forge integer 1, 0

是否检测证件真伪,0为不检测,1为检测, 默认为0

confidence integer 1, 0

是否输出置信度,0为不输出置信度,1为输出置信度,默认为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
+ type string

证件类型

+ type_description string

证件类型中文描述

+ image_angle integer

原图的偏转角度

+ rotated_image_width integer

旋转后的图片宽度

+ rotated_image_height integer

旋转后的图片高度

+ item_list array
   ++ key string

身份证内容项的名称:姓名,性别,民族等,具体可见下面description描述

   ++ value string

身份证内容项的值

   ++ description string

身份证内容项的中文名称描述

   ++ position array

身份证内容项的值在原图中的坐标,是个长度为8的数组 [0,1,2,3,4,5,6,7] - (0,1) 左上角坐标 - (2,3) 右上角坐标 - (4,5) 右下角坐标 - (6,7) 左下角坐标

   ++ confidence number

item_list 中识别字段的说明

字段名 描述
name 姓名
sex 性别
nationality 民族
birth 出生
address 住址
id_number 公民身份证号
issue_authority 签发机关
validate_date 有效期限
head_portrait 头像
id_number_image 身份证号码图像
crop_image 切边图像
is_gray 是否为黑白复印件

JSON结构示例

{
  "code": 200,
  "message": "success",
  "result": {
    "image_angle": 156,
    "rotated_image_width": 500,
    "rotated_image_height": 500,
    "item_list": [
      {
        "key": "name",
        "value": "合小合",
        "description": "姓名",
        "confidence": 0.9,
        "position": [
          0,
          10,
          500,
          10,
          500,
          300,
          0,
          300
        ]
      }
    ],
    "type_description": "身份证",
    "type": "id_card"
  }
}

错误码说明

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

联系我们