You need to enable JavaScript to run this app.
导航
文字识别
  • 文档首页
    • /
  • 文字识别

调用方式

最近更新时间：2023.08.18 18:00:55

首次发布时间：2022.07.21 17:01:19

我的收藏
接口简介

支持对营业执照所有字段的识别。

限制条件
名称内容
输入要求1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。
2. 图片像素尺寸：最小 256 x 256 像素，最大 2048 x 2048 像素。为了保证文字识别效果，推荐图片中营业执照最短边长不低于256像素。
3. 文件大小：
a.要求Base64编码和urlencode之后不超过 8 MB。营业执照主体尽量占据图片主要区域，不支持黑白图片。
b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。
4. 输入文件过大时，返回的HttpCode如下：400/413/502。
5. 注意图片质量：保证营业执照图片足够清晰，不应该有因为压缩导致的噪声，避免对营业执照正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。
6. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。
7. 输入多页PDF时，默认只识别第一页。
请求说明

基本信息

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded (传入参数不包含类型File)
multipart/form-data (参数包含类型File)
是否需要鉴权是

请求参数

header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，文字识别一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

参数可选/必选类型说明
Action必选String接口名，取值：OcrClueLicense
Version必选String版本号，取值：2020-08-26

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String图片/PDF文件，base64编码
注意: 只需要传图片/PDF的base64值，类似data:image/png;base64的图片头不要传入
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。
version可选String营业执照识别服务版本，可选"v1"/"v2", 默认为"v1"
输出说明

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

data 字段说明

字段类型说明备注
license_mainmain_info主页面信息字段说明见下方，注意区分v1/v2版本
license_posArray of Point营业执照在图中的位置信息v2版本新增的字段
注意: 输入是PDF文件时，以相对坐标的形式返回

main_info v1版本 字段说明

字段类型说明备注
证书类型String证书类型主页信息
经营者String经营者主页信息
名称String名称主页信息
类型String类型主页信息
经营场所String经营场所主页信息
组成形式String组成形式主页信息
注册日期String注册日期主页信息
经营范围String经营范围主页信息
统一社会编码String统一社会编码主页信息
核准日期String核准日期主页信息

main_info v2版本 字段说明

字段类型说明备注
has_headBool证书类型主页信息
has_tailBool经营者主页信息
is_copyBool名称主页信息
credit_codeValue统一社会编码/统一社会信用代码主页信息
nameValue公司名称主页信息
typeValue公司类型主页信息
addressValue住所/地址/经验场所主页信息
legal_personValue公司法人/经营者主页信息
registered_capitalValue注册资本主页信息
registration_dateValue成立日期/注册日期主页信息
valid_periodValue营业期限主页信息
business_scopeValue经营范围主页信息
approval_dateValue核准日期主页信息

Value 字段说明

字段类型说明备注
valString相应字段识别的内容
posBox相应字段在图中的位置（用矩形框表示）
注意: 输入是PDF文件时，以相对坐标的形式返回

Box 字段说明

输入图片文件时，返回字段说明：

字段类型说明备注
xInt左上角位置的横坐标
yInt左上角位置的纵坐标
widthInt宽度
heightInt高度

输入PDF文件时，返回字段说明：

字段类型说明备注
xFloat左上角位置的横坐标占页面宽度的百分比
yFloat左上角位置的纵坐标占页面高度的百分比
widthFloat宽度占页面宽度的百分比
heightFloat高度占页面高度的百分比

Point 字段说明

输入图片文件时，返回字段说明：

字段类型说明备注
xInt点的横坐标
yInt点的枞坐标

输入PDF文件时，返回字段说明：

字段类型说明备注
xFloat点的横坐标占页面宽度的百分比
yFloat点的枞坐标占页面高度的百分比

输出示例

主页面图片返回值示例 v1版本

{
  "code": 10000,
  "data": {
    "license_main": {
      "证书类型": "营业执照",
      "经营者": "侯自洪",
      "名称": "滨江市黑土区新市侯自洪服装加工厂",
      "类型": "个体工商户",
      "经营场所": "滨江市黑土区三元里大道合益西街3号楼501室",
      "组成形式": "个人经营",
      "注册日期": "2012年07月18日",
      "经营范围": "纺织服装、服饰业(具体经营项目请登录滨江市商事主体信息公示平台查询。依法须经批准的项目,经相关部门批准后方可开展经营活动。)",
      "统一社会编码": "92440101MA5A8HW84P",
      "核准日期": "2017年12月22日"
    }
  },
  "message": "Success",
  "request_id": "68885909392882421901603875062",
  "status": 10000,
  "time_elapsed": "684.655197ms"
}

主页面图片返回值示例 v2版本

{
  "code": 10000,
  "data": {
    "license_main": {
      "has_head": true,
      "has_tail": true,
      "is_copy": false,
      "credit_code": {
        "val": "9133XXXXXXXXLLCC11",
        "pos": {
          "x": 110,
          "y": 268,
          "width": 159,
          "height": 14
        }
      },
      "name": {
        "val": "滨江XXXXXX股份有限公司",
        "pos": {
          "x": 229,
          "y": 360,
          "width": 221,
          "height": 19
        }
      },
      "type": {
        "val": "股份有限公司（非上市、自然人投资或控股）",
        "pos": {
          "x": 228,
          "y": 393,
          "width": 295,
          "height": 20
        }
      },
      "address": {
        "val": "滨江省黑土市XXXXXXXXX",
        "pos": {
          "x": 731,
          "y": 455,
          "width": 285,
          "height": 19
        }
      },
      "legal_person": {
        "val": "XXXX",
        "pos": {
          "x": 229,
          "y": 426,
          "width": 48,
          "height": 17
        }
      },
      "registered_capital": {
        "val": "壹亿捌仟万元整",
        "pos": {
          "x": 731,
          "y": 361,
          "width": 111,
          "height": 20
        }
      },
      "registration_date": {
        "val": "XXXX年XX月XX日",
        "pos": {
          "x": 731,
          "y": 393,
          "width": 129,
          "height": 17
        }
      },
      "valid_period": {
        "val": "XXXX年XX月XX日 至 长期",
        "pos": {
          "x": 731,
          "y": 424,
          "width": 192,
          "height": 18
        }
      },
      "business_scope": {
        "val": "承接;海洋、水利工程;服务:建设项目管理，工艺美术品、模型、包装设计，网页设计，企业品牌设计，动漫、多媒体设计、制作，承办会务会展，企业营销策划，广告设计、制作，网络技术、计算机软件的技术开发、技术咨询、技术服务，经济信息咨询;其他无需报经审批的一切合法项目。（依法须经批准的项目，经相关部门批准后方可开展经营活动）",
        "pos": {
          "x": 227,
          "y": 452,
          "width": 347,
          "height": 108
        }
      },
      "approval_date": {
        "val": "XXXX年XX月XX日",
        "pos": {
          "x": 807,
          "y": 645,
          "width": 165,
          "height": 26
        }
      }
    },
    "license_pos": [
      {
        "x": 0,
        "y": 3
      },
      {
        "x": 1088,
        "y": 0
      },
      {
        "x": 1095,
        "y": 770
      },
      {
        "x": 3,
        "y": 770
      }
    ]
  },
  "message": "Success",
  "request_id": "02166125395071726050340cdb10108c95f289097ddec3cfcbd46",
  "status": 10000,
  "time_elapsed": "953.000316ms"
}
错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

HttpCode错误码错误消息描述
20010000无请求成功
40050205"Image Size Exceeds Maximum Limit: please compress the image"输入文件过大
40050206"Invalid Input Image: image is empty"输入图片为空
40050207"Image Decode Error: image format unsupported"图片解码错误
40050217"Process PDF File Error."处理PDF文件错误