Help Center/ Optical Character Recognition/ API Reference/ API/ Peru ID Card

Updated on 2024-06-19 GMT+08:00

View PDF

Peru ID Card

Function

This API detects and extracts text from images of Peru-issued identity cards and converts the text into a structured format. For details about the constraints on using this API, see Constraints and Limitations. For details about how to use this API, see Introduction to OCR.

Figure 1 Peru ID card example 1
Click to enlarge

Figure 2 Peru ID card example 2
Click to enlarge

Constraints and Limitations

Only ID cards issued by Peru can be recognized.
Only images in PNG, JPG, JPEG, BMP, or TIFF format can be recognized.
No side of the image can be smaller than 15 or larger than 8,192 pixels.
An ID card to be recognized must occupy more than 25% of the image. When scanning an ID card, ensure that the entire ID card is displayed in the image.
An ID card can be rotated to any angle.
The ID card in the image can be moderately distorted, but the aspect ratio cannot be distorted by more than 10%.
Illuminated or dark images can be recognized, but the accuracy may be compromised.

Calling Method

For details, see Calling APIs.

Prerequisites

Before using this API, subscribe to the service and complete authentication. For details, see Subscribing to an OCR Service and Authentication.

Before you use the service for the first time, subscribe to the service by clicking Subscribe. You only need to subscribe to the service once. If you have not subscribed to the service yet, error "ModelArts.4204" will be displayed when you call this API. Before you call the API, log in to the OCR console and subscribe to the corresponding service. Ensure that you make the subscription to the service in the same region where you want to call this API.

URI

POST /v2/{project_id}/ocr/peru-id-card

**Table 1** URI parameters
Parameter	Mandatory	Description
endpoint	Yes	Endpoint, which is the request address for calling an API. The endpoint varies depending on services in different regions. For more details, see Endpoints.
project_id	Yes	Project ID, which can be obtained by referring to Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token Used to obtain the permission to call APIs. The token is the value of X-Subject-Token in the response header in Authentication.
Content-Type	Yes	String	MIME type of the request body. The value is application/json.
Enterprise-Project-Id	No	String	Enterprise project ID. OCR allows you to use Enterprise Project Management Service (EPS) to split fees for resources used by different user groups and users. To obtain the enterprise project ID, go to the Enterprise Project Management console, click the enterprise project name, and obtain the enterprise project ID on the enterprise project details page. For details about how to create an enterprise project, see Optical Character Recognition User Guide. NOTE: After an enterprise project is created, parameter transfer involves the following scenarios: If a correct enterprise project ID is carried and the OCR service can be used properly, the bills will be categorized under the corresponding enterprise project for that ID. If an enterprise project ID that is in the correct format but does not actually exist is carried, and the OCR service can be used properly, the bills will display the corresponding non-existent enterprise project ID. If no enterprise project ID or an enterprise project ID with incorrect format (such as special characters) is carried, and the OCR service can be used properly, the bills will be categorized under default.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
image	No	String	Set either this parameter or url. Base64 encoded string of an image file. The image file has a size limit of 10 MB. No side of the image can be smaller than 15 or larger than 8,192 pixels. Only images in JPG, PNG, BMP, or TIFF format can be recognized. PDFs with multiple pages can also be recognized. An example is /9j/4AAQSkZJRgABAg.... If the image data contains an unnecessary prefix, the error "The image format is not supported" is reported.
url	No	String	Set either this parameter or image. Image URL. Currently, the following URLs are supported: Public HTTP/HTTPS URL URL provided by OBS. You need to be authorized to use OBS data, including service authorization, temporary authorization, and anonymous public authorization. For details, see Configuring Access Permissions of OBS. NOTE: The API response time depends on the image download time. If the image download takes a long time, the API call will fail. Ensure that the storage service where the image to be detected resides is stable and reliable. OBS is recommended for storing image data.
return_portrait_image	No	Boolean	Whether to return the portrait. The options are: true: The Base64 encoded string of the portrait on the ID card will be returned. false: A null value is returned. If this parameter is not set, the default value false is used, and a null value is returned.
return_portrait_location	No	Boolean	Whether to return the location of the portrait on the ID card. The options are: true: The location of the portrait on the ID card will be returned. false: A null value is returned. If this parameter is not set, the default value false is used, and a null value is returned.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
result	PeruIdCardResult object	Result of a successful API call. This parameter is not included for a failed call.

**Table 5** PeruIdCardResult
Parameter	Type	Description
cui_number	String	ID number
first_surname	String	First surname
second_surname	String	Second surname
given_name	String	Other names
sex	String	Gender
marital_status	String	Marital status
birth_date	String	Date of birth
nationality	String	Nationality
issue_date	String	Date of issue
expiry_date	String	Date of expiration
birth_place	String	Birthplace code
voting_group	String	Voting group
organ_donation	String	Organ donation
registration_date	String	Registration date
portrait_image	String	Base64 encoded string of the portrait. This parameter is returned only when return_portrait_image is set to true.
portrait_location	Array<Array<Integer>>	Location of the portrait on the original image. This parameter is returned only when return_portrait_location is set to true. The image is displayed in a list. The list contains the two-dimensional coordinates (x,y) of the four vertices in the portrait area. The origin of the coordinates is the upper left corner of the image. The X axis is horizontal, and the Y axis is vertical.
address	String	Address
department	String	Department
province	String	Province
district	String	District
remarks	String	Remarks
machine_code1	String	Machine code in the first line
machine_code2	String	Machine code in the second line
machine_code3	String	Machine code in the third line
duplicate	Boolean	Whether the ID card is a duplicate. The options are: true: The ID card is a duplicate. false: The ID card is not a duplicate.
confidence	Map<String,Number>	Confidence of related fields. A higher confidence indicates a higher accuracy of the field identified. The confidence is calculated using algorithms and is not equal to the accuracy.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code of a failed API call. For details, see Error Codes. This parameter is not returned for a successful call.
error_msg	String	Error message when the API call fails This parameter is not returned for a successful call.

Example Request

endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.
For example, Peru ID Card OCR is deployed in the LA-Santiago region. The endpoint is ocr.la-south-2.myhuaweicloud.com or ocr.la-south-2.myhuaweicloud.cn. The request URL is https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/peru-id-card. project_id is the project ID. For 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 Base64 encoded string of an image.)

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

{
  "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...",
  "return_portrait_image" : true,
  "return_portrait_location" : true
}

Example request (Method 2: Use the image URL.)

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

{
  "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName",
  "return_portrait_image" : true,
  "return_portrait_location" : true
}

Example Response

Status code: 200

Example response for a successful request

{
  "result" : {
    "cui_number" : "4687xxx3-4",
    "first_surname" : "LANDEO",
    "second_surname" : "CARHUALLANQUI",
    "given_name" : "YONATHAN DAVID",
    "sex" : "M",
    "marital_status" : "C",
    "birth_date" : "xx 01 1991",
    "nationality" : "xx",
    "issue_date" : "31 12 xx21",
    "expiry_date" : "13 11 2025",
    "birth_place" : 240102,
    "voting_group" : "xx",
    "organ_donation" : "xx",
    "registration_date" : "26 03 2009",
    "portrait_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA...",
    "portrait_location" : [ [ 25, 55 ], [ 138, 55 ], [ 139, 216 ], [ 26, 217 ] ],
    "address" : "xxx",
    "department" : "xxx",
    "province" : "xxx",
    "district" : "xxx",
    "remarks" : "xxx",
    "machine_code1" : "I<PER46873763<0<<<<<<<<<<<<<<<",
    "machine_code2" : "9101276M2511133PER<<<<<<<<<<<0",
    "machine_code3" : "LANDEO<<YONATHAN<DAVID<<<<<<<<",
    "duplicate" : false,
    "confidence" : {
      "cui_number" : 0.9282,
      "first_surname" : 0.9016,
      "second_surname" : 0.9309,
      "given_name" : 0.9307,
      "sex" : 0.8633,
      "marital_status" : 0.6044,
      "birth_date" : 0.8828,
      "nationality" : 0.8826,
      "issue_date" : 0.9226,
      "expiry_date" : 0.9158,
      "birth_place" : 0.9122,
      "voting_group" : 0.8826,
      "organ_donation" : 0.8826,
      "registration_date" : 0.913,
      "portrait_image" : 0.945,
      "portrait_location" : 0.994,
      "address" : 0.9021,
      "department" : 0.8973,
      "province" : 0.8769,
      "district" : 0.8647,
      "remarks" : 0.8476,
      "machine_code1" : 0.8384,
      "machine_code2" : 0.9363,
      "machine_code3" : 0.9046,
      "duplicate" : 0.8703
    }
  }
}

Status code: 400

Example response for a failed request

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

Example SDK Code

The example SDK code is as follows:

You are advised to update the SDKs to the latest versions before use to prevent the local outdated SDKs from being unable to use the latest OCR functions.

Transfer the Base64 encoded string of the Peru ID card image for recognition.

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
import com.huaweicloud.sdk.ocr.v1.*;
import com.huaweicloud.sdk.ocr.v1.model.*;


public class RecognizePeruIdCardSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OcrClient client = OcrClient.newBuilder()
                .withCredential(auth)
                .withRegion(OcrRegion.valueOf("<YOUR REGION>"))
                .build();
        RecognizePeruIdCardRequest request = new RecognizePeruIdCardRequest();
        PeruIdCardRequestBody body = new PeruIdCardRequestBody();
        body.withReturnPortraitLocation(true);
        body.withReturnPortraitImage(true);
        body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...");
        request.withBody(body);
        try {
            RecognizePeruIdCardResponse response = client.recognizePeruIdCard(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

Transfer the URL of the Peru ID card image for recognition.

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
import com.huaweicloud.sdk.ocr.v1.*;
import com.huaweicloud.sdk.ocr.v1.model.*;


public class RecognizePeruIdCardSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OcrClient client = OcrClient.newBuilder()
                .withCredential(auth)
                .withRegion(OcrRegion.valueOf("<YOUR REGION>"))
                .build();
        RecognizePeruIdCardRequest request = new RecognizePeruIdCardRequest();
        PeruIdCardRequestBody body = new PeruIdCardRequestBody();
        body.withReturnPortraitLocation(true);
        body.withReturnPortraitImage(true);
        body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName");
        request.withBody(body);
        try {
            RecognizePeruIdCardResponse response = client.recognizePeruIdCard(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

Transfer the Base64 encoded string of the Peru ID card image for recognition.

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkocr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OcrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OcrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizePeruIdCardRequest()
        request.body = PeruIdCardRequestBody(
            return_portrait_location=True,
            return_portrait_image=True,
            image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
        )
        response = client.recognize_peru_id_card(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

Transfer the URL of the Peru ID card image for recognition.

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkocr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OcrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OcrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizePeruIdCardRequest()
        request.body = PeruIdCardRequestBody(
            return_portrait_location=True,
            return_portrait_image=True,
            url="https://BucketName.obs.myhuaweicloud.com/ObjectName"
        )
        response = client.recognize_peru_id_card(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

Transfer the Base64 encoded string of the Peru ID card image for recognition.

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := ocr.NewOcrClient(
        ocr.OcrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizePeruIdCardRequest{}
	returnPortraitLocationPeruIdCardRequestBody:= true
	returnPortraitImagePeruIdCardRequestBody:= true
	imagePeruIdCardRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
	request.Body = &model.PeruIdCardRequestBody{
		ReturnPortraitLocation: &returnPortraitLocationPeruIdCardRequestBody,
		ReturnPortraitImage: &returnPortraitImagePeruIdCardRequestBody,
		Image: &imagePeruIdCardRequestBody,
	}
	response, err := client.RecognizePeruIdCard(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

Transfer the URL of the Peru ID card image for recognition.

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := ocr.NewOcrClient(
        ocr.OcrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizePeruIdCardRequest{}
	returnPortraitLocationPeruIdCardRequestBody:= true
	returnPortraitImagePeruIdCardRequestBody:= true
	urlPeruIdCardRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName"
	request.Body = &model.PeruIdCardRequestBody{
		ReturnPortraitLocation: &returnPortraitLocationPeruIdCardRequestBody,
		ReturnPortraitImage: &returnPortraitImagePeruIdCardRequestBody,
		Url: &urlPeruIdCardRequestBody,
	}
	response, err := client.RecognizePeruIdCard(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

For more SDK code examples in various programming languages, see the Sample Code tab on the right of the API Explorer page, which can automatically generate corresponding SDK code examples.