1. 接口说明
营业执照识别,通过全球领先的 OCR(光学字符识别 Optical Character Recognition)技术,对营业执照图片进行识别,返回营业执照图片上的注册号、名称、类型、住所、法定代表人、注册资本、成立日期、营业期限和经营范围等信息,可以省去用户手动录入的过程,自动完成营业执照信息的结构化和图像数据的采集,可以很方便对接客户的后台数据系统,给用户带来极大的便利,方便用户保存。
2. 接口地址
POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/business_license HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8
3. 请求参数
在 Http Request Header 中配置授权认证参数,见【接口描述-授权认证】。其中 X-Param 为各配置参数组成的JSON串经BASE64编码之后的字符串,原始JSON串各字段说明如下:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
engine_type | string | 是 | 引擎类型,固定为business_license | business_license |
imei | string | 否 | 手机序列号 | 12345678 |
osid | string | 否 | 操作系统版本 | Android |
ua | string | 否 | 厂商|全称|机型信息|操作系统版本|分辨率 | vivo|vivoY67L|PD1612|ANDROID6.0|720*1280 |
X-Param生成示例:
原始JSON串:
{
"engine_type": "business_license",
}
BASE64编码(即X-Param):
eyJlbmdpbmVfdHlwZSI6ICJidXNpbmVzc19saWNlbnNlIn0=
在 Http Request Body 中配置以下参数:
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
image | string | 是 | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,仅支持jpg格式,推荐 jpg 文件设置为:最短边大于 1200 像素,图像质量 75 以上,位深度 24。 | exSI6ICJlbiIsCgkgICAgInBvc2l0aW9uIjogImZhbHNlIgoJf… |
_注:_base64编码后大小会增加约1/3
4. 返回值
返回值为json串,各字段如下:
参数 | 类型 | 说明 |
---|---|---|
code | string | 结果码(具体见错误码) |
data | json | 详见data说明 |
desc | string | 描述 |
sid | string | 会话ID |
其中sid字段主要用于追查问题,如果出现问题,可以提供sid给讯飞技术人员帮助确认问题。
data各字段说明如下:
参数 | 说明 | |
---|---|---|
type | 营业执照 | |
biz_license_company_name | 名称 | |
biz_license_company_type | 类型/公司类型/主体类型 | |
biz_license_address | 住所/经营场所/主要经营场所/营业场所 | |
biz_license_registration_code | 注册号 | |
biz_license_serial_number | 证照编号 | |
biz_license_owner_name | 法定代表人/负责人/经营者/经营者姓名 | |
biz_license_reg_capital | 注册资本 | |
biz_license_paidin_capital | 实收资本 | |
biz_license_scope | 经营范围 | |
biz_license_start_time | 成立日期/注册日期 | |
biz_license_composing_form | 组成形式 | |
biz_license_operating_period | 营业期限 | |
biz_license_credit_code | 统一社会信用代码 | |
error_code | 错误码 | 识别错误码 |
error_msg | 错误信息 | 错误原因描述 |
其中的error_msg和error_code的取值范围及说明对照表:
error_code | error_msg | 说明 |
---|---|---|
0 | ok | 正常返回 |
40001 | invalid parameter | 参数不对 |
40002 | missing parameter | 缺少参数 |
40003 | invalid user or password | 账号或密码不对 |
40004 | missing request body | 没有HTTP body |
40005 | invalid image format | HTTP body不是图像或者不支持该格式 |
40006 | invalid image size | 图片太大或太小 |
40007 | fail to recognize | 识别失败 |
40008 | invalid content type | 通过HTTP form上传图片时,Content-Type无效 |
40009 | corrupted request body | 请求body损坏 |
40010 | fail to extract image | 提取图像裸数据失败 |
50001 | backend down | 后台服务器宕机 |
50004 | timeout | 识别超时 |
90099 | unknown | 未知错误 |
结果示例如下:
失败结果:
{
"code": "10106",
"desc": "invalid parameter|invalid X-Appid",
"data": "",
"sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}
成功结果:
{
"code": "0",
"data": {
"biz_license_address": "合肥市高新区望江西路666号",
"biz_license_company_name": "科大讯飞股份有限公司",
"biz_license_company_type": "股份有限公司",
"biz_license_credit_code": "11111122222000000W",
"biz_license_operating_period": "2010年12月06日至永久",
"biz_license_owner_name": "刘庆峰",
"biz_license_reg_capital": "贰佰万元整",
"biz_license_scope": "商务信息咨询,计算机网络技术开发技术咨询及技术服务,会议及展览服务,计算机软件开发,销售。 (以上经营范围法律,法规禁止经营的,不得经营;法律,法规,国务院规定需经审批的,未获审批前,不得经营。)",
"biz_license_start_time": "2010年12月06日",
"error_code": 0,
"error_msg": "ok",
"type": "营业执照"
},
"desc": "success",
"sid": "wcr00000005@dx11730e7981af000100"
}
5. 调用示例
Copyright © iflytek.com 2018 all right reserved,powered by Gitbook该文件修订时间:2019-05-07 07:12:51