注册
文档中心
API调试

请求URL

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

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

错误信息

duration integer

响应时间

result object

图片结果信息

+type string

当前识别证件类型

  • taiwan_idcard_front:台湾身份证正面
  • taiwan_idcard_back:台湾身份证反面
  • other:其他
+rotated_image_width integer

旋转后图片宽度

+rotated_image_height integer

旋转后图片高度

+image_angle integer

图片旋转角度

+item_list array

识别数据

   ++value string

识别字段结果

   ++description string

识别字段描述

   ++position array

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

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

识别字段类型

  • name:姓名
  • date_of_birth:出生
  • sex:性别
  • date_of_issue:發证日期
  • id:統一编號
  • father:父
  • mother:母
  • spouse:配偶
  • grade_of_military:役别
  • place_of_birth:出生地
  • address:住址
  • number:数字
   ++confidence number

字段置信度

item_list 中识别字段的说明

字段名 描述
name 姓名
date_of_birth 出生
sex 性别
date_of_issue 發证日期
id 統一编號
father
mother
spouse 配偶
grade_of_military 役别
place_of_birth 出生地
address 住址
number 数字

JSON结构示例

{
  "code": 200,
  "message": "string",
  "duration": 0,
  "result": {
    "type": "taiwan_idcard_front",
    "rotated_image_width": 0,
    "rotated_image_height": 0,
    "image_angle": 0,
    "item_list": [
      {
        "value": "string",
        "description": "string",
        "position": [
          0
        ],
        "key": "name",
        "confidence": 0
      }
    ]
  }
}

错误码说明

错误码 描述
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 服务器内部错误
体验中心
人工客服
400-6666-582