/ocr/business_license

优质
小牛编辑
174浏览
2023-12-01

1.接口描述

该 API 用于识别营业执照图像上的文字信息,主要支持横竖两版、三证合一和五证合一。

  • 图片要求:
    1. 格式为 JPG(JPEG),BMP,PNG
    2. 宽和高大于 8px,小于等于 4000px
    3. 小于等于 1.5 MB,建议300k以内
  • 支持自动旋转图片方向:
    1. 上传的图片中包含有 exif 方向信息,先按此信息旋转、翻转后再进行识别
    2. 如果照片方向混乱且 exif 方向信息不存在或不正确,自动旋转方向并调整

请求方式

POST

请求 URL

https://cloudapi.linkface.cn/ocr/business_license

2.请求参数

字段类型必需描述
api_idstringAPI 账户
api_secretstringAPI 密钥
filefile见下方注释需上传的图片文件,上传本地图片进行检测时选取此参数
urlstring见下方注释图片网络地址,采用抓取网络图片方式时需选取此参数
image_idstring见下方注释图片的id,在云端上传过图片可采用此参数

请求参数 file,urlimage_id 必须选择其中的一个。

url 中含有不少特殊字符,若将 URL 放入 Query String 中则需要对这些字符进行转义,所有中文和特殊字符必需以UTF-8编码转义。 目前支持 http/https 等协议的网络地址。下载限时 5s,超时后仍未下载完成则属于失败。 参数 file 需把图片文件的内容以 multipart/form-data 的形式放到 POST 消息体中。

3.返回参数

字段类型说明
request_idstring本次请求的id
statusstring返回状态,正常为 OK,其他值表示失败,详见错误码
image_idstring使用file、url方式上传图片返回的图片的云端id
resultarray of object营业执照文字信息, statusOK时才返回,详见result 数组中字段的结构

result 数组中字段的结构为:

字段类型说明
codestring注册号 或 社会统一信用代码
namestring名称
typestring类型
addressstring住所 或 经营场所
personstring法定代表人 或 经营者
capitalstring注册资本
datestring成立时间
valid_periodstring营业期限,若为长期或永久,则返回"29991231"
businessstring经营范围
营业执照识别结果示例
{
    "result": {
        "date": "20160520",
        "capital": "50万人民币",
        "code": "914405************",
        "address": "汕头市龙湖区**************",
        "valid_period": "20260520",
        "business": "食品销售及网上销售;销售及网上销售:日用百货、针纺织品、服装鞋帽、服装服饰、皮革制品、装饰品、工艺美术品;汽车销售。",
        "person": "陈**",
        "name": "汕头市****有限公司",
        "type": "有限责任公司(自然人独资)"
    },
    "request_id": "TID2d431a6248914216a231bd6ee65f844e",
    "status": "OK",
    "image_id": "e8a201f4f4e44f6489fe9613ada23628"
}

4.错误码

状态码status 字段说明
400ENCODING_ERROR参数非UTF-8编码
400DOWNLOAD_TIMEOUT网络地址图片获取超时
400IMAGE_ID_NOT_EXIST图片不存在
400CORRUPT_IMAGE文件不是图片文件或已经损坏
400DOWNLOAD_ERROR网络地址图片获取失败
400IMAGE_FILE_SIZE_TOO_BIG图片体积过大
400INVALID_IMAGE_FORMAT_OR_SIZE图片大小或格式不符合要求
400INVALID_ARGUMENT请求参数错误,具体原因见 reason 字段内容
400INVALID_BUSINESS_LICENSE营业执照图片识别错误,非营业执照图片
401UNAUTHORIZED账号或密钥错误
401KEY_EXPIRED账号过期,具体情况见 reason 字段内容
403RATE_LIMIT_EXCEEDED调用频率超出限额
403NO_PERMISSION无调用权限
403OUT_OF_QUOTA调用次数超出限额
404NOT_FOUND请求路径错误
500OCR_SERVER_ERROR识别服务器异常
500INTERNAL_ERROR服务器内部错误
输出样例
{
  "status": "INVALID_ARGUMENT",
  "reason": "must specify 'image_id', 'file' or 'url' argument",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.输入示例

  • cURL 样例
curl -X POST "https://cloudapi.linkface.cn/ocr/business_license?api_id=ID&api_secret=SECRET" \
  -F file=@/PATH/TO/IMAGE
  • HTTPie 样例
http -f POST "https://cloudapi.linkface.cn/ocr/business_license?api_id=ID&api_secret=SECRET" \
  file@/PATH/TO/IMAGE