服务端 API 文档

文档捉虫大赛火热进行中,好礼多多> HOT

1. 接口描述

此接口处于预下线状态 。

预计下线时间:2023-06-20 15:52:40

接口请求域名: ocr.tencentcloudapi.com 。

库源服务调整,该接口在2023年6月1日将正式下线。

本接口支持营业执照信息的识别与准确性核验,返回的真实工商照面信息比营业执照识别及核验(基础版)接口更详细。

您可以输入营业执照注册号或营业执照图片(若两者都输入则只用注册号做查询),接口返回查询到的工商照面信息,并比对要校验的字段与查询结果的一致性。

查询到工商信息包括:统一社会信用代码、组织机构代码、经营期限、法人姓名、经营状态、经营业务范围及方式、注册资金、注册币种、登记机关、开业日期、企业(机构)类型、注销日期、吊销日期、许可经营项目、一般经营项目、核准时间、省、地级市、区/县、住所所在行政区划代码、行业门类代码、行业门类名称、国民经济行业代码、国民经济行业名称、经营(业务)范围等。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VerifyBizLicense。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。
ImageBase64 String 用于入参是营业执照图片的场景,ImageBase64和ImageUrl必须提供一个,如果都提供,只使用 ImageUrl。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
ImageUrl String 用于入参是营业执照图片的场景,ImageBase64和ImageUrl必须提供一个,如果都提供,只使用 ImageUrl。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
ImageConfig String 用于入参是营业执照图片的场景,表示需要校验的参数:RegNum(注册号或者统一社会信用代码),Name(企业名称),Address(经营地址)。选择后会返回相关参数校验结果。RegNum为必选,Name和Address可选。
格式为{RegNum: true, Name:true/false, Address:true/false}

设置方式参考:
Config = Json.stringify({"Name":true,"Address":true})
API 3.0 Explorer 设置方式参考:
Config = {"Name":true,"Address":true}
RegNum String 用于入参是文本的场景,RegNum表示注册号或者统一社会信用代码。若没有传入营业执照图片,则RegNum为必选项,若图片和RegNum都传入,则只使用RegNum。
Name String 用于入参是文本的场景,Name表示企业名称。Name为可选项,填写后会返回Name的校验结果。
Address String 用于入参是文本的场景,Address表示经营地址,填写后会返回Address的校验结果。

3. 输出参数

参数名称 类型 描述
ErrorCode Integer 状态码
CreditCode String 统一社会信用代码
OrgCode String 组织机构代码
OpenFrom String 经营期限自(YYYY-MM-DD)
OpenTo String 经营期限至(YYYY-MM-DD)
FrName String 法人姓名
EnterpriseStatus String 经营状态,包括:成立、筹建、存续、在营、开业、在册、正常经营、开业登记中、登记成立、撤销、撤销登记、非正常户、告解、个体暂时吊销、个体转企业、吊销(未注销)、拟注销、已注销、(待)迁入、(待)迁出、停业、歇业、清算等。
OperateScopeAndForm String 经营(业务)范围及方式
RegCap String 注册资金(单位:万元)
RegCapCur String 注册币种
RegOrg String 登记机关
EsDate String 开业日期(YYYY-MM-DD)
EnterpriseType String 企业(机构)类型
CancelDate String 注销日期
RevokeDate String 吊销日期
AbuItem String 许可经营项目
CbuItem String 一般经营项目
ApprDate String 核准时间
Province String 省(返回空值)
City String 地级市(返回空值)
County String 区\县(返回空值)
AreaCode String 住所所在行政区划代码(返回空值)
IndustryPhyCode String 行业门类代码(返回空值)
IndustryPhyName String 行业门类名称(返回空值)
IndustryCode String 国民经济行业代码(返回空值)
IndustryName String 国民经济行业名称(返回空值)
OperateScope String 经营(业务)范围
VerifyRegNo String 要核验的工商注册号
RegNo String 工商注册号
VerifyEnterpriseName String 要核验的企业名称
EnterpriseName String 企业名称
VerifyAddress String 要核验的注册地址
Address String 注册地址
RegNumResult BizLicenseVerifyResult 验证结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 营业执照识别及核验详细版示例代码(使用图片进行核验)

营业执照识别及核验详细版示例代码(使用图片进行核验)

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyBizLicense
<公共请求参数>

{
    "ImageUrl": "https://xx/a.jpg",
    "ImageConfig": "{\"RegNum\":true,\"Name\":true,\"Address\":true}"
}

输出示例

{
    "Response": {
        "ErrorCode": 0,
        "CreditCode": "911101085636549482",
        "OrgCode": "563654948",
        "OpenFrom": "2010-10-21",
        "OpenTo": "2030-10-20",
        "FrName": "谢兰芳",
        "EnterpriseStatus": "在营(开业)",
        "OperateScopeAndForm": "利用互联网经营游戏产品运营、网络游戏虚拟货币发行、从事互联网文化产品的展览、比赛活动;经营电信业务(以增值电信业务经营许可证核定范围为准)(增值电信业务经营许可证有效期至2023年11月28日);人力资源服务;销售第三类医疗器械;专利代理;技术开发、技术转让、技术咨询;设计、制作、代理、发布广告;基础软件服务;应用软件服务;销售自行开发的产品、医疗器械I类、II类、计算机、软件及辅助设备、通讯设备、机械设备、电子产品;货物进出口、技术进出口、代理进出口;企业管理咨询;市场调查;商标代理;著作权代理服务;移动电信、宽带网络的技术服务;代理记账。(企业依法自主选择经营项目,开展经营活动;代理记账以及依法须经批准的项目,经相关部门批准后依批准的内容开展经营活动;不得从事本市产业政策禁止和限制类项目的经营活动。)",
        "RegCap": "14250.00",
        "RegCapCur": "人民币",
        "RegOrg": "北京市工商行政管理局海淀分局",
        "EsDate": "2010-10-21",
        "EnterpriseType": "其他有限责任公司",
        "CancelDate": "",
        "RevokeDate": "",
        "AbuItem": "",
        "CbuItem": "",
        "ApprDate": "2019-11-20",
        "Province": "北京",
        "City": "北京市",
        "County": "海淀区",
        "AreaCode": "110108",
        "IndustryPhyCode": "I",
        "IndustryPhyName": "信息传输、软件和信息技术服务业",
        "IndustryCode": "6439",
        "IndustryName": "其他互联网平台",
        "OperateScope": "利用互联网经营游戏产品运营、网络游戏虚拟货币发行、从事互联网文化产品的展览、比赛活动;经营电信业务(以增值电信业务经营许可证核定范围为准)(增值电信业务经营许可证有效期至2023年11月28日);人力资源服务;销售第三类医疗器械;专利代理;技术开发、技术转让、技术咨询;设计、制作、代理、发布广告;基础软件服务;应用软件服务;销售自行开发的产品、医疗器械I类、II类、计算机、软件及辅助设备、通讯设备、机械设备、电子产品;货物进出口、技术进出口、代理进出口;企业管理咨询;市场调查;商标代理;著作权代理服务;移动电信、宽带网络的技术服务;代理记账。(企业依法自主选择经营项目,开展经营活动;代理记账以及依法须经批准的项目,经相关部门批准后依批准的内容开展经营活动;不得从事本市产业政策禁止和限制类项目的经营活动。)",
        "VerifyRegNo": "911101085636549482",
        "RegNo": "110108013297537",
        "VerifyEnterpriseName": "腾讯云计算(北京)有限责任公司",
        "EnterpriseName": "腾讯云计算(北京)有限责任公司",
        "VerifyAddress": "北京市海淀区知春路49号3层西部309",
        "Address": "北京市海淀区知春路49号3层西部309",
        "RegNumResult": {
            "RegNum": "0",
            "Name": "-1",
            "Address": "0"
        },
        "RequestId": "3ec63378-af53-4b26-babc-4dbb63c84716"
    }
}

示例2 营业执照识别及核验详细版示例代码(输入关键字段进行核验)

营业执照识别及核验详细版示例代码(输入关键字段进行核验)

输入示例

POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyBizLicense
<公共请求参数>

{
    "RegNum": "911101085636549482",
    "Name": "腾讯云计算(北京)有限责任公司",
    "Address": "北京市海淀区知春路49号3层西部309"
}

输出示例

{
    "Response": {
        "AbuItem": "",
        "Address": "北京市海淀区西北旺东路10号院西区9号楼4层101",
        "ApprDate": "2023-01-17",
        "AreaCode": "",
        "CancelDate": "",
        "CbuItem": "",
        "City": "北京市",
        "County": "海淀区",
        "CreditCode": "911101085636549482",
        "EnterpriseName": "腾讯云计算(北京)有限责任公司",
        "EnterpriseStatus": "存续",
        "EnterpriseType": "有限责任公司(法人独资)",
        "ErrorCode": 0,
        "EsDate": "2010-10-21",
        "FrName": "谢兰芳",
        "IndustryCode": "",
        "IndustryName": "",
        "IndustryPhyCode": "",
        "IndustryPhyName": "",
        "OpenFrom": "2010-10-21",
        "OpenTo": "2030-10-20",
        "OperateScope": "",
        "OperateScopeAndForm": "利用互联网经营游戏产品运营、网络游戏虚拟货币发行、从事互联网文化产品的展览、比赛活动;经营电信业务(以增值电信业务经营许可证核定范围为准)(增值电信业务经营许可证有效期至2023年11月28日);人力资源服务;销售第三类医疗器械;专利代理;技术开发、技术转让、技术咨询;设计、制作、代理、发布广告;基础软件服务;应用软件服务;销售自行开发的产品、医疗器械I类、II类、计算机、软件及辅助设备、通讯设备、机械设备、电子产品;货物进出口、技术进出口、代理进出口;企业管理咨询;市场调查;商标代理;著作权代理服务;移动电信、宽带网络的技术服务;代理记账。(市场主体依法自主选择经营项目,开展经营活动;代理记账以及依法须经批准的项目,经相关部门批准后依批准的内容开展经营活动;不得从事国家和本市产业政策禁止和限制类项目的经营活动。)",
        "OrgCode": "563654948",
        "Province": "北京",
        "RegCap": "",
        "RegCapCur": "",
        "RegNo": "110108013297537",
        "RegNumResult": {
            "Address": "-1",
            "Name": "0",
            "RegNum": "0"
        },
        "RegOrg": "",
        "RequestId": "e2aba233-f200-4234-807f-fd12b1a6649c",
        "RevokeDate": "",
        "VerifyAddress": "北京市海淀区知春路49号3层西部309",
        "VerifyEnterpriseName": "腾讯云计算(北京)有限责任公司",
        "VerifyRegNo": "911101085636549482"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DataSourceQueryFailed 数据源查询失败。
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.NoBizLicense 非营业执照。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.QueryNoRecord 查询无记录。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录