注册
文档中心
API调试

功能描述

外国人永久居留身份证ai接口

请求URL

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

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
参数名 数据类型 是否必填 允许的值 描述
portrait integer 1, 0

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

请求体说明(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 错误码,详见“错误码说明”
duration integer

响应时间

message string

错误信息

result object
+ category object
   ++ DETAILS_KEY3 string

说明见 DETAILS_KEY1

   ++ DETAILS_KEY2 string

说明见 DETAILS_KEY1

   ++ DETAILS_KEY1 string

details 下字段的类型,DETAILS_KEY1 为 details 下的同名字段, 其值有以下三种类型

  • one_to_one: 只有单个值
  • one_to_many: 有多个值
  • item_list: 表格类型
+ details object

图片OCR识别结果

   ++ name object

姓名

    +++ value string

字段识别结果

    +++ position array

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

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

字段的描述

   ++ chinese_name object

中文姓名

    +++ value string

字段识别结果

    +++ position array

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

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

字段的描述

   ++ previous_number object

曾持有号码

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ issued_authority object

签发机关

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ portrait object

头像

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ id_number object

证件号码

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ period_of_validity object

有效期限

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ nationality object

国籍

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ date_of_birth object

出生日期

    +++ description string

字段的描述

    +++ position array

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

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

字段识别结果

   ++ sex object

性别

    +++ value string

字段识别结果

    +++ description string

字段的描述

    +++ position array

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

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

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

+ rotated_image_height integer

正方向时图片高

+ rotated_image_width integer

正方向时图片的宽

+ type string

当前证件类型

  • foreign_permanent_resident_id_card_head 证件头像面
  • foreign_permanent_resident_id_card_emblem 证件国徽面
  • foreign_permanent_resident_id_card 证件正反面混合

JSON结构示例

{
  "code": 200,
  "message": "success",
  "result": {
    "category": {
      "DETAILS_KEY3": "",
      "DETAILS_KEY1": "",
      "DETAILS_KEY2": ""
    }
  },
  "duration": 55521970
}

错误码说明

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

联系我们