Chile ID Card OCR

Function

Chile ID Card OCR recognizes the text in a Chile ID card image and returns the recognition 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.

Figure 1 Chile ID Card OCR example

Prerequisites

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

Before using the service for the first time, you need to enable the service by clicking Subscribe. You only need to subscribe to the service once. If the service is not enabled, an error message with error code "ModelArts.4204" will be displayed when you call the service. Before calling the service, log in to the OCR console and enable the service. Ensure that the region where the service is enabled is the same as that where the service is called.

URI

POST https://{endpoint}/v2/{project_id}/ocr/chile-id-card

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, the endpoint of Chile ID Card OCR deployed in the LA-Santiago region is ocr.la-south-2.myhuaweicloud.com. The request URL is https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card. project_id indicates 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://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card
  
  Request Header: 
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  Request Body:
  {
      "image": "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgA..."
  }

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

  POST https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card
  
  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://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card"
  token = "Actual token value obtained by the user"
  headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
  
  imagepath = r'./data/myanmar-driver-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": {
        "surname": [
            "FERNANDEZ",
            "GATICA"
        ],
        "given_name": "MARCELA CAROLINA",
        "nationality": "CHILENA",
        "sex": "F",
        "birth": "21 FEB 1982",
        "document_number": "100000001",
        "issue_date": "1 SEP 2013",
        "expiry_date": "10 AGO 2023",
        "number": "12.749.625-K",
        "confidence": {
             "surname": 0.9584,
             "given_name": 0.8106,
             "nationality": 0.7026,
             "sex": 0.5879,
             "birth": 0.9305,
             "document_number": 0.8181,
             "issue_date": 0.8518,
             "expiry_date": 0.7757,
             "number": 0.9528
        }
   }
}

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.