后浪云小程序教程:微信小程序 OCR·businessLicense

ocr.businessLicense

本接口应在服务器端调用,详细说明参见 服务端API。

本接口支持 云调用。需开发者工具版本 >= 1.02.1904090(最新 稳定版下载)

wx-server-sdk >= 0.4.0

本接口提供基于小程序的营业执照 OCR 识别

调用方式:

  • HTTPS 调用
  • 云调用

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/cv/ocr/bizlicense?img_url=ENCODE_URL&access_token=ACCESS_TOCKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
img_urlstring要检测的图片 url,传这个则不用传 img 参数。
imgFormDataform-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodestring错误码
errmsgstring错误信息
reg_numstring注册号
serialstring编号
legal_representativestring法定代表人姓名
enterprise_namestring企业名称
type_of_organizationstring组成形式
addressstring经营场所/企业住所
type_of_enterprisestring公司类型
business_scopestring经营范围
registered_capitalstring注册资本
paid_in_capitalstring实收资本
valid_periodstring营业期限
registered_datestring注册日期/成立日期
cert_positionstring营业执照位置
img_sizestring图片大小

使用说明

接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用,次数限制为500次/天。

使用 Tips 此接口为后台接口,可基于自有业务承载情况,搭配小程序的拍照、相册选照等一起使用,即可完成身份证照片的采集、上传、识别、信息返回等流程,用于需要基于身份证、银行卡等实体卡或证,采集照片或文字信息等的业务场景。

图片说明 文件大小限制:小于2M

返回字段仅包含当前营业执照图片中存在的字段,若对应字段不存在则不返回

拍摄图片样例

请求数据示例

示例1:

curl https://api.weixin.qq.com/cv/ocr/bizlicense?img_url= ENCODE_URL&access_token=ACCESS_TOCKEN

示例2:

curl -F ‘img=@test.jpg’“https://api.weixin.qq.com/cv/ocr/bizlicense?access_token=ACCESS_TOCKEN”

返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "reg_num": "123123",                                                     //注册号
    "serial": "123123",                                                      //编号
    "legal_representative": "张三",                                          //法定代表人姓名
    "enterprise_name": "XX饮食店",                                           //企业名称
    "type_of_organization": "个人经营",                                      //组成形式
    "address": "XX市XX区XX路XX号",                                           //经营场所/企业住所
    "type_of_enterprise": "xxx",                                             //公司类型
    "business_scope": "中型餐馆(不含凉菜、不含裱花蛋糕,不含生食海产品)。",  //经营范围
    "registered_capital": "200万",                                           //注册资本
    "paid_in_capital": "200万",                                              //实收资本
    "valid_period": "2019年1月1日",                                          //营业期限
    "registered_date": "2018年1月1日",                                       //注册日期/成立日期
    "cert_position": {                                                       //营业执照位置
        "pos": {
            "left_top": {
                "x": 155,
                "y": 191
            },
            "right_top": {
                "x": 725,
                "y": 157
            },
            "right_bottom": {
                "x": 743,
                "y": 512
            },
            "left_bottom": {
                "x": 164,
                "y": 525
            }
        }
    },
    "img_size": {                                                            //图片大小
        "w": 966,
        "h": 728
    }
}

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.ocr.businessLicense

需在 config.json 中配置 ocr.businessLicense API 的权限, 详情

请求参数

属性类型默认值必填说明
imgUrlstring要检测的图片 url,传这个则不用传 img 参数。
imgFormDataform-data 中媒体文件标识,有filename、filelength、content-type等信息,传这个则不用传 img_url。

img 的结构

属性类型默认值必填说明
contentTypestring数据类型,传入 MIME Type
valueBuffer文件 Buffer

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodestring错误码
errMsgstring错误信息
regNumstring注册号
serialstring编号
legalRepresentativestring法定代表人姓名
enterpriseNamestring企业名称
typeOfOrganizationstring组成形式
addressstring经营场所/企业住所
typeOfEnterprisestring公司类型
businessScopestring经营范围
registeredCapitalstring注册资本
paidInCapitalstring实收资本
validPeriodstring营业期限
registeredDatestring注册日期/成立日期
certPositionstring营业执照位置
imgSizestring图片大小

异常

Object

抛出的异常

属性类型说明
errCodestring错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本

使用说明

接口限制 内测期间已认证的订阅号、服务号、企业号、小程序可直接调用,次数限制为500次/天。

使用 Tips 此接口为后台接口,可基于自有业务承载情况,搭配小程序的拍照、相册选照等一起使用,即可完成身份证照片的采集、上传、识别、信息返回等流程,用于需要基于身份证、银行卡等实体卡或证,采集照片或文字信息等的业务场景。

图片说明 文件大小限制:小于2M

返回字段仅包含当前营业执照图片中存在的字段,若对应字段不存在则不返回

拍摄图片样例

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.ocr.businessLicense({
        imgUrl: 'ENCODE_URL'
      })
    return result
  } catch (err) {
    return err
  }
}

// cloud = require('wx-server-sdk')
// ...
// 方法返回 Promise
cloud.openapi.ocr.businessLicense({
  img: {
    contentType: 'image/png',
    value: Buffer
  }
})

返回数据示例

{
    "errcode": 0,
    "errmsg": "ok",
    "reg_num": "123123",                                                     //注册号
    "serial": "123123",                                                      //编号
    "legal_representative": "张三",                                          //法定代表人姓名
    "enterprise_name": "XX饮食店",                                           //企业名称
    "type_of_organization": "个人经营",                                      //组成形式
    "address": "XX市XX区XX路XX号",                                           //经营场所/企业住所
    "type_of_enterprise": "xxx",                                             //公司类型
    "business_scope": "中型餐馆(不含凉菜、不含裱花蛋糕,不含生食海产品)。",  //经营范围
    "registered_capital": "200万",                                           //注册资本
    "paid_in_capital": "200万",                                              //实收资本
    "valid_period": "2019年1月1日",                                          //营业期限
    "registered_date": "2018年1月1日",                                       //注册日期/成立日期
    "cert_position": {                                                       //营业执照位置
        "pos": {
            "left_top": {
                "x": 155,
                "y": 191
            },
            "right_top": {
                "x": 725,
                "y": 157
            },
            "right_bottom": {
                "x": 743,
                "y": 512
            },
            "left_bottom": {
                "x": 164,
                "y": 525
            }
        }
    },
    "img_size": {                                                            //图片大小
        "w": 966,
        "h": 728
    }
}

THE END