Function

Quota Invoice OCR recognizes the text in a quota invoice image and returns the structured result 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.

If the image contains multiple cards and tickets, call Auto Classification OCR.

Prerequisites

Before using Quota Invoice 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/quota-invoice

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, Quota Invoice 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/quota-invoice. 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/quota-invoice
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body: 
  {
      "image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAg..." 
  }

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

  POST  https://{endpoint}/v2/{project_id}/ocr/quota-invoice
  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/quota-invoice"
  token = "Actual token value obtained by the user"
  headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
  
  imagepath = r'./data/quota-invoice-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.
  
  # imageurl = 'https://BucketName.obs.xxxx.com/ObjectName'  # URL of the image.
  # payload = {'url': imageurl} 
  response = requests.post(url, headers=headers, json=payload)
  print(response.text)

Example Response

Status code: 200

Successful response example

{
    "result": {
        "amount": "Amount recognized from the image",
        "code": "244031XXXX11", 
        "location": "Location recognized from the image",
        "number": "91XXXX61",
        "confidence": {
            "amount": 0.9971, 
            "code": 0.9908, 
            "location": 0.9706, 
            "number": 0.9943
        }
    }
}

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.