1. 接口描述
此接口处于预下线状态 。
预计下线时间:2023-06-20 15:52:24
接口请求域名: ocr.tencentcloudapi.com 。
库源服务调整,该接口在2023年6月1日将正式下线。
本接口支持营业执照信息的识别与准确性核验。
您可以通过输入营业执照注册号或营业执照图片(若两者都输入则只用注册号做查询)进行核验,接口返回查询到的工商照面信息,并比对要校验的字段与查询结果的一致性。查询到工商信息包括:统一社会信用代码、经营期限、法人姓名、经营状态、经营业务范围、注册资本等。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:VerifyBasicBizLicense。 |
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为可选项,填写后会返回Address的校验结果。 |
RegCapital | 否 | Integer | 1表示输出注册资本字段(单位:万元),其他值表示不输出。默认不输出。 |
EstablishTime | 否 | Boolean | true表示展示成立/注册日期 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ErrorCode | Integer | 状态码,成功时返回0 |
CreditCode | String | 统一社会信用代码 |
Opfrom | String | 经营期限自(YYYY-MM-DD) |
Opto | String | 经营期限至(YYYY-MM-DD) |
Frname | String | 法人姓名 |
Entstatus | String | 经营状态,包括:成立、筹建、存续、在营、开业、在册、正常经营、开业登记中、登记成立、撤销、撤销登记、非正常户、告解、个体暂时吊销、个体转企业、吊销(未注销)、拟注销、已注销、(待)迁入、(待)迁出、停业、歇业、清算等。 |
Zsopscope | String | 经营业务范围 |
Reason | String | 查询的状态信息 |
Oriregno | String | 原注册号 |
VerifyRegno | String | 要核验的工商注册号 |
Regno | String | 工商注册号 |
VerifyEntname | String | 要核验的企业名称 |
Entname | String | 企业名称 |
VerifyDom | String | 要核验的住址 |
Dom | String | 住址 |
RegNumResult | BizLicenseVerifyResult | 验证结果 |
RegCapital | String | 注册资本(单位:万元),只有输入参数regCapital为1的时候才输出 |
EstablishTime | String | 成立/注册日期,只有输入参数EstablishTime为true时展示,默认为空 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 营业执照识别及核验基础版示例代码(输入关键字段进行核验)
营业执照识别及核验基础版示例代码(输入关键字段进行核验)
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyBasicBizLicense
<公共请求参数>
{
"RegNum": "911101085636549482",
"EstablishTime": true,
"Name": "腾讯云计算(北京)有限责任公司",
"Address": "北京市海淀区知春路49号3层西部309"
}
输出示例
{
"Response": {
"CreditCode": "911101085636549482",
"Dom": "北京市海淀区西北旺东路10号院西区9号楼4层101",
"Entname": "腾讯云计算(北京)有限责任公司",
"Entstatus": "存续",
"ErrorCode": 0,
"EstablishTime": "2010-10-21",
"Frname": "谢兰芳",
"Opfrom": "2010-10-21",
"Opto": "2030-10-20",
"Oriregno": "",
"Reason": "成功",
"RegCapital": "",
"RegNumResult": {
"Address": "-1",
"Name": "0",
"RegNum": "0"
},
"Regno": "110108013297537",
"RequestId": "29c58e1d-9d47-4fec-bb89-bc7239a26f50",
"VerifyDom": "北京市海淀区知春路49号3层西部309",
"VerifyEntname": "腾讯云计算(北京)有限责任公司",
"VerifyRegno": "911101085636549482",
"Zsopscope": "利用互联网经营游戏产品运营、网络游戏虚拟货币发行、从事互联网文化产品的展览、比赛活动;经营电信业务(以增值电信业务经营许可证核定范围为准)(增值电信业务经营许可证有效期至2023年11月28日);人力资源服务;销售第三类医疗器械;专利代理;技术开发、技术转让、技术咨询;设计、制作、代理、发布广告;基础软件服务;应用软件服务;销售自行开发的产品、医疗器械I类、II类、计算机、软件及辅助设备、通讯设备、机械设备、电子产品;货物进出口、技术进出口、代理进出口;企业管理咨询;市场调查;商标代理;著作权代理服务;移动电信、宽带网络的技术服务;代理记账。(市场主体依法自主选择经营项目,开展经营活动;代理记账以及依法须经批准的项目,经相关部门批准后依批准的内容开展经营活动;不得从事国家和本市产业政策禁止和限制类项目的经营活动。)"
}
}
示例2 营业执照识别及核验基础版示例代码(使用图片进行核验)
营业执照识别及核验基础版示例代码(使用图片进行核验)
输入示例
POST / HTTP/1.1
Host: ocr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyBasicBizLicense
<公共请求参数>
{
"ImageUrl": "https://xx/a.jpg",
"ImageConfig": "{\"RegNum\":true,\"Name\":true,\"Address\":true}",
"EstablishTime": "false"
}
输出示例
{
"Response": {
"ErrorCode": 0,
"CreditCode": "911101085636549482",
"Opfrom": "2010-10-21",
"Opto": "",
"Frname": "谢兰芳",
"Entstatus": "在营",
"Zsopscope": "利用互联网经营游戏产品运营、网络游戏虚拟货币发行、从事互联网文化产品的展览、比赛活动;经营电信业务(以增值电信业务经营许可证核定范围为准)(增值电信业务经营许可证有效期至2023年11月28日);人力资源服务;销售第三类医疗器械;专利代理;技术开发、技术转让、技术咨询;设计、制作、代理、发布广告;基础软件服务;应用软件服务;销售自行开发的产品、医疗器械I类、II类、计算机、软件及辅助设备、通讯设备、机械设备、电子产品;货物进出口、技术进出口、代理进出口;企业管理咨询;市场调查;商标代理;著作权代理服务;移动电信、宽带网络的技术服务;代理记账。(企业依法自主选择经营项目,开展经营活动;代理记账以及依法须经批准的项目,经相关部门批准后依批准的内容开展经营活动;不得从事本市产业政策禁止和限制类项目的经营活动。)",
"Reason": "成功",
"Oriregno": "",
"VerifyRegno": "911101085636549482",
"Regno": "110108013297537",
"VerifyEntname": "腾讯云计算(北京)有限责任公司",
"Entname": "腾讯云计算(北京)有限责任公司",
"VerifyDom": "北京市海淀区知春路49号3层西部309",
"Dom": "北京市海淀区知春路49号3层西部309",
"RegCapital": "",
"EstablishTime": "",
"RegNumResult": {
"RegNum": "0",
"Name": "-1",
"Address": "0"
},
"RequestId": "b469636f-efbe-4016-b3e6-c74d7389b346"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DataSourceQueryFailed | 数据源查询失败。 |
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.NoBizLicense | 非营业执照。 |
FailedOperation.OcrFailed | OCR识别失败。 |
FailedOperation.QueryNoRecord | 查询无记录。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |
ResourcesSoldOut.ChargeStatusException | 计费状态异常。 |