1. 接口描述
接口请求域名: ocr.tencentcloudapi.com 。
本接口支持营业执照信息的识别与准确性核验。您可以通过输入营业执照关键字段或传入营业执照图片提供所需的验证信息,接口返回真实的企业工商照面信息及核验结果,包括统一社会信用代码、经营期限、法人姓名、经营状态、经营业务范围、状态信息、原注册号、要核验的工商注册号、工商注册号、要核验的企业名称、企业名称、要核验的注册住址、注册住址、核验结果、注册资本共16个基础字段。
推荐使用 API Explorer
单击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:VerifyBasicBizLicense。 |
Version | 是 | String | 公共参数,本接口取值:2018-11-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou |
ImageBase64 | 否 | String | 用于入参是营业执照图片的场景,ImageBase64和ImageUrl必选一个输入。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 |
ImageUrl | 否 | String | 用于入参是营业执照图片的场景,ImageBase64和ImageUrl必选一个输入。 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。 |
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为必选项。 |
Name | 否 | String | 用于入参是文本的场景,Name表示企业名称。Name为可选项,填写后会返回Name的校验结果。 |
Address | 否 | String | 用于入参是文本的场景,Address表示经营地址,填写后会返回Name的校验结果。 |
RegCapital | 否 | Integer | 1表示输出注册资本字段(单位:万元),其他值表示不输出。默认不输出。 |
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的时候才输出 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 营业执照识别及核验基础版示例代码(输入关键字段进行核验)
输入示例
https://ocr.tencentcloudapi.com/?Action=VerifyBasicBizLicense
RegNum=xxxxx&Name=xxxxx&Address=xxxxx
&<公共请求参数>
输出示例
{
"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",
"RegNumResult": {
"RegNum": "0",
"Name": "0",
"Address": "0"
},
"RequestId": "8d9627c4-eb52-4a8d-8565-5b07ad436c9f"
}
}
示例2 营业执照识别及核验基础版示例代码(使用图片进行核验)
输入示例
https://ocr.tencentcloudapi.com/?Action=VerifyBasicBizLicense
&ImageUrl=https://xx/a.jpg&ImageConfig={"RegNum":true, "Name":true, "Address":true}
&<公共请求参数>
输出示例
{
"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",
"RegNumResult": {
"RegNum": "0",
"Name": "-1",
"Address": "0"
},
"RequestId": "b469636f-efbe-4016-b3e6-c74d7389b346"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DownLoadError | 文件下载失败。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.OcrFailed | OCR 识别失败。 |
FailedOperation.UnKnowError | 未知错误。 |
FailedOperation.UnOpenError | 服务未开通。 |
InvalidParameterValue.InvalidParameterValueLimit | 参数值错误。 |
LimitExceeded.TooLargeFileError | 文件内容太大。 |