查看文档
示例代码
API调试
接入技术服务
香港身份证识别
功能描述
香港身份证
请求URL
https://api.textin.com/robot/v1.0/api/hk_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
| 参数名 | 数据类型 | 是否必填 | 允许的值 | 描述 |
|---|---|---|---|---|
| head_portrait | integer | 否 | 1, 0 |
是否返回头像切图base64码，1为是，0为否, 默认为1 |
请求体说明（Request Body）
支持以下两种请求格式
1. Content-Type: application/octet-stream
要上传的图片，目前支持jpg, png, bmp, pdf, tiff, 单帧gif等大部分格式.
请注意，请求体的数据格式为本地文件的二进制流，非 FormData 或其他格式。文件大小不超过 10M，图像宽高须介于 20 和 10000（像素）之间。
2. Content-Type: text/plain
请求体的数据格式为文本，内容为在线文件的URL链接（支持http以及https协议）。在线文件大小不超过 10M，图像宽高须介于 20 和 10000（像素）之间。
响应体说明 （Response）
Content-Type: application/json
JSON结构说明如下：
说明：所有接口响应中均包含字段 x_request_id（string类型），作为请求的唯一标识。
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | integer | 错误码，详见“错误码说明” |
| message | string |
错误信息 |
| duration | integer |
响应时间 |
| result | object |
图片结果信息 |
| + image_angle | integer |
图片顺时针旋转角度 |
| + rotated_image_width | integer |
旋转后图片宽度 |
| + rotated_image_height | integer |
旋转后图片高度 |
| + type | string |
当前识别证件类型，当为other的时候,代表无法识别的图片
|
| + item_list | array |
常规结构化结果 |
| ++ description | string |
结构化结果字段描述 |
| ++ value | string |
结构化结果字段的值 |
| ++ position | array |
识别的字段在旋转后图中的坐标, 是个长度为8的数组 [0,1,2,3,4,5,6,7]
|
| ++ key | string |
识别字段类型
|
