企业资质证照识别

功能描述

credentials information extration

企业资质-智能文档抽取服务-API文档

请求URL

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

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

参数名	数据类型	是否必填	允许的值	描述
file_name	string	否	见描述	待抽取样本的文件名（含后缀名）

请求体说明（Request Body）

支持以下两种请求格式

1. Content-Type: application/octet-stream

支持的文件格式：png, jpg, jpeg, pdf；文档最大处理页数为20页。

请注意，请求体的数据格式为本地文件的二进制流，非 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类型），作为请求的唯一标识。

字段名	类型	描述
version	string	版本号
code	integer	错误码，详见“错误码说明”
message	string	错误信息
duration	integer	推理时间(ms)
result	object
+ markdown	string	整份文档的markdown
+ details	array	字段的识别信息
++ doc_type	string	文档的类型
++ page_number	array	所处的页码
++ fields	object	提取的字段结构化结果
++ stamps	array	印章识别结果
+++ color	string	当前印章颜色红色蓝色黑色其他
+++ image	string	印章图片被转为base64编码的字符串
+++ position	array	印章的坐标信息
+++ stamp_shape	string	当前印章形状圆章椭圆章方章三角章菱形章其他
+++ type	string	当前印章类型公章个人章专用章其他合同专用章财务专用章发票专用章业务专用章
+++ value	string	印章的文本内容
+ documents	array	文档每一页的文档元素信息
++ page_id	integer	所在页
++ position	array	坐标信息
++ paragraph_id	integer	当前段落id
++ type	string	当前元素的类型 paragraph：段落类型，包括正文、标题、公式等文字信息 image：图片 table：表格，当为表格时，text里存储的为表格的html信息
++ text	string	文字信息

JSON结构示例

{"version":"v1.6.5","code":200,"message":"success","duration":28,"result":{"markdown":"string","details":[{"doc_type":"string","page_number":[0],"fields":{"additionalProp1":[{"value":"string","bounding_regions":[{"page_number":0,"value":"string","position":[343,56,459,56,459,90,343,90],"char_pos":[[343,56,459,56,459,90,343,90]]}]}],"additionalProp2":[{"value":"string","bounding_regions":[{"page_number":0,"value":"string","position":[343,56,459,56,459,90,343,90],"char_pos":[[343,56,459,56,459,90,343,90]]}]}],"additionalProp3":[{"value":"string","bounding_regions":[{"page_number":0,"value":"string","position":[343,56,459,56,459,90,343,90],"char_pos":[[343,56,459,56,459,90,343,90]]}]}]},"tables":[{"row_count":0,"column_count":0,"cells":[{"additionalProp1":{"value":"string","bounding_regions":[{"page_number":0,"value":"string","position":[343,56,459,56,459,90,343,90],"char_pos":[[343,56,459,56,459,90,343,90]]}]},"additionalProp2":{"value":"string","bounding_regions":[{"page_number":0,"value":"string","position":[343,56,459,56,459,90,343,90],"char_pos":[[343,56,459,56,459,90,343,90]]}]},"additionalProp3":{"value":"string","bounding_regions":[{"page_number":0,"value":"string","position":[343,56,459,56,459,90,343,90],"char_pos":[[343,56,459,56,459,90,343,90]]}]}}]}],"stamps":[{"color":"红色","image":"string","position":[956,583,1362,590,1355,990,950,983],"stamp_shape":"圆章","type":"公章","value":"string"}]}],"documents":[[{"page_id":0,"position":[956,583,1362,590,1355,990,950,983],"paragraph_id":0,"type":"paragraph","text":"string"}]]}}

错误码说明

错误码	描述
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	文件类型不支持，接口会返回实际检测到的文件类型，如“当前文件类型为.gif”
40302	上传文件大小不符，文件大小不超过 10M
40303	文件类型不支持
40304	图片尺寸不符，图像宽高须介于 20 和 10000（像素）之间
40305	识别文件未上传
40306	QPS超过限制，收到此状态码时请勿重试，持续请求可能触发IP流控，如需扩容请联系商务
40400	无效的请求链接，请检查链接是否正确
30203	基础服务故障，请稍后重试
500	服务器内部错误