Vietnam ID Card

Function

This API detects and extracts text from images of Vietnam-issued ID 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.

Constraints and Limitations

Only ID cards issued by Vietnam 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 can be rotated to any angle.
Illuminated or dark images, or images with anti-counterfeit watermarks 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/vietnam-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 uses 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 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 JPEG, JPG, PNG, BMP, or TIFF format can 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. The URL cannot contain Chinese characters. If Chinese characters exist, they must be encoded using UTF-8.
side	No	String	Whether the front or back side of the ID card is displayed. The options are: front: front of the Vietnam ID card back: back of the Vietnam ID card If the value of this parameter is empty or not included, the system will automatically recognize whether the image is the front or back of an ID card. It is recommended to set this parameter for higher accuracy.
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: The Base64 encoded string of the portrait on the ID card will not be returned. If this parameter is not specified, false is used by default. In this case, the Base64 encoded string of the portrait on the ID card will not be 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: The location of the portrait on the ID card will not be returned.
return_idcard_type	No	Boolean	Whether to return the ID card type. The options are: true: The ID card type will be returned, indicating that the ID card is the original ID card or copy of the original ID card. false: The ID card type will not be returned.
return_text_location	No	Boolean	Location of a text block. The options are: true: All text blocks will be returned. false: Text blocks will not be returned. If this parameter is not specified, the system does not return the location of any text blocks by default. If a non-Boolean value is entered, an error message will be displayed, indicating that the parameter is invalid.

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
result	Table 5 object	Calling result This parameter is not returned when the API fails to be called.

**Table 5** VietnamIdCardResult
Parameter	Type	Description
side	String	Side of the ID card. The value can be front or back.
number	String	Card number
full_name	String	Name
birth_date	String	Date of birth
sex	String	Gender
nationality	String	Nationality
origin_place	String	Place of origin
residence_place	String	Residence
expiry_date	String	Validity period
personal_identification	String	Personal identification. This field is returned when side is set to back.
issue_date	String	Date of issue. This field is returned when side is set to back.
machine_code1	String	Machine-readable code in the first line on the back of an ID card. This field is returned when side is set to back.
machine_code2	String	Machine-readable code in the second line on the back of an ID card. This field is returned when side is set to back.
machine_code3	String	Machine-readable code in the third line on the back of an ID card. This field is returned when side is set to back.
confidence	Object	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.
portrait_image	String	Base64 encoded string of the portrait when return_portrait_image is set to true.
portrait_location	Array<Array<Integer>>	Location of the portrait on the original image when return_portrait_location is set to true, including the two-dimensional coordinates (x,y) of the four vertices of the portrait, which is displayed in a list. The origin is at the upper left corner of the image. The X axis is horizontal, and the Y axis is vertical.
idcard_type	String	ID card type returned when return_idcard_type is set to true. normal indicates the original ID card, copy indicates the copy of the ID card, and screen indicates a recapture of an ID card image on the screen.
text_location	Object	Location of all fields identified on the original image, including the two-dimensional coordinates (x,y) of the four vertices in all text areas. The image coordinate system is used. The coordinate origin is the upper left corner of the image, the X axis is horizontal, and the Y axis is vertical.

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 when the API is successfully called.

Example Request

The endpoint is the request URL for calling an API. Endpoints vary according to services and regions. For details, see Endpoints. For example, Vietnam ID Card OCR is deployed in the CN-Hong Kong region. The endpoint is ocr.ap-southeast-1.myhuaweicloud.com. The request URL is https://ocr.ap-southeast-1.myhuaweicloud.com/v2/{project_id}/ocr/vietnam-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.

POST https://{endpoint}/v2/{project_id}/ocr/vietnam-id-card 
 
{ 
  "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." 
}

Example Response

Status code: 200

Example response for a successful request

{ 
  "result" : { 
    "side" : "front", 
    "number" : "784-1995-xxxxxxx-4", 
    "full_name" : "VŨ THỊ HẢI YẾN", 
    "birth_date" : "08-08-1980", 
    "sex" : "Nữ", 
    "nationality" : "Việt Nam", 
    "origin_place" : "Giới Phiên Thành phố Yên Bái Yên Bải", 
    "residence_place" : "Thôn Ngòi Châu Giới Phiên Thành phố Yên Bái Yên Bái", 
    "expiry_date" : "08/07/2030", 
    "confidence" : { 
      "number" : 0.9993, 
      "full_name" : 0.9983, 
      "birth_date" : 0.9998, 
      "sex" : 0.9999, 
      "nationality" : 0.9999, 
      "origin_place" : 0.9855, 
      "residence_place" : 0.9984, 
      "expiry_date" : 0.9995 
    }, 
    "idcard_type" : "normal", 
    "portrait_image" : "/9j/4AAQSkZJRgABAQAAAQABAA...", 
    "portrait_location" : [ [ 217, 359 ], [ 582, 360 ], [ 573, 882 ], [ 199, 885 ] ] 
  } 
}

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 Vietnam 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 RecognizeVietnamIdCardSolution {

    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();
        RecognizeVietnamIdCardRequest request = new RecognizeVietnamIdCardRequest();
        VietnamIdCardRequestBody body = new VietnamIdCardRequestBody();
        body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...");
        request.withBody(body);
        try {
            RecognizeVietnamIdCardResponse response = client.recognizeVietnamIdCard(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 Vietnam 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 RecognizeVietnamIdCardSolution {

    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();
        RecognizeVietnamIdCardRequest request = new RecognizeVietnamIdCardRequest();
        VietnamIdCardRequestBody body = new VietnamIdCardRequestBody();
        body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName");
        request.withBody(body);
        try {
            RecognizeVietnamIdCardResponse response = client.recognizeVietnamIdCard(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 Vietnam 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 = os.getenv("CLOUD_SDK_AK")
    sk = 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 = RecognizeVietnamIdCardRequest()
        request.body = VietnamIdCardRequestBody(
            image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
        )
        response = client.recognize_vietnam_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 Vietnam 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 = os.getenv("CLOUD_SDK_AK")
    sk = 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 = RecognizeVietnamIdCardRequest()
        request.body = VietnamIdCardRequestBody(
            url="https://BucketName.obs.myhuaweicloud.com/ObjectName"
        )
        response = client.recognize_vietnam_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 Vietnam 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.RecognizeVietnamIdCardRequest{}
	imageVietnamIdCardRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
	request.Body = &model.VietnamIdCardRequestBody{
		Image: &imageVietnamIdCardRequestBody,
	}
	response, err := client.RecognizeVietnamIdCard(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

Transfer the URL of the Vietnam 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.RecognizeVietnamIdCardRequest{}
	urlVietnamIdCardRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName"
	request.Body = &model.VietnamIdCardRequestBody{
		Url: &urlVietnamIdCardRequestBody,
	}
	response, err := client.RecognizeVietnamIdCard(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.