Function

Business License OCR recognizes the text on the first page of a business license and returns the structured information in JSON format. For details about the constraints on using this API, see Constraints. For details about how to use this API, see Introduction to OCR.

Prerequisites

Before using Business License OCR, you need to apply for the service and complete authentication. For details, see Subscribing to OCR and Authentication.

URI

POST https://{endpoint}/v2/{project_id}/ocr/business-license

Request Parameters

Response Parameters

Response parameters and status codes vary in different recognition results. They are described as below.

Status code: 200

Status code: 400

Request Example

• The endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.

  For example, Business License OCR is deployed in the CN North-Beijing4 region. The endpoint is ocr.cn-north-4.myhuaweicloud.com. The request URL is https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/business-license. project_id is the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

• For details about how to obtain a token, see Making an API Request.

• Request example (Method 1: Use the image Base64 string.)

  POST https://{endpoint}/v2/{project_id}/ocr/business-license
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
  }

• Request example (Method 2: Use the image URL.)

  POST https://{endpoint}/v2/{project_id}/ocr/business-license
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "url":"https://BucketName.obs.xxxx.com/ObjectName"
  }

• Sample code for a Python 3 request (For codes in other languages, refer to the following sample or use OCR SDK.)

  # encoding:utf-8
  
  import requests
  import base64
  
  url = "https://{endpoint}/v2/{project_id}/ocr/business-license"
  token = "Actual token value obtained by the user"
  headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
  
  imagepath = r'./data/business-license-demo.png'
  with open(imagepath, "rb") as bin_data:
      image_data = bin_data.read()
  image_base64 = base64.b64encode(image_data).decode("utf-8")  # Base64 encoding of images.
  payload = {"image": image_base64}  # url or image.
  response = requests.post(url, headers=headers, json=payload)
  print(response.text)

Example Response

Status code: 200

Successful response example

{
    "result": {
        "registration_number": "1234567890A",
        "name": "Enterprise name recognized from the image",
        "type": "Enterprise type recognized from the image",
        "address": "XXXX",
        "legal_representative": "Legal representative recognized from the image",
        "registered_capital": "Registered capital recognized from the image",
        "found_date": "Establishment date recognized from the image",
        "business_term": "Business term recognized from the image",
        "business_scope": "Business scope recognized from the image",
        "issue_date": "Issue date recognized from the image",
        "confidence": {
            "registration_number": 0.9562,
            "name": 0.9999,
            "type": 0.9631,
            "address": 0.9996,
            "legal_representative": 0.9256,
            "registered_capital": 0.9862,
            "found_date": 0.9796,
            "business_term": 0.9636,
            "business_scope": 0.9584,
            "issue_date": 0.9344
        }
}

Status code: 400

Failure response example

{
    "error_code": "AIS.0103", 
    "error_msg": "The image size does not meet the requirements." 
}

Status Codes

For details about status codes, see Status Codes.

Error Codes

For details about error codes, see Error Codes.