文档首页> 文字识别 OCR> API参考> API> 秘鲁身份证识别

更新时间：2024-06-19 GMT+08:00

在线调试

CLI示例

查看PDF

秘鲁身份证识别

功能介绍

识别秘鲁身份证图片中的文字内容，并将识别的结构化结果返回给用户。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。

图1 秘鲁身份证示例图1
点击放大

图2 秘鲁身份证示例图2
点击放大

约束与限制

只支持秘鲁身份证的识别。
只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。
图像各边的像素大小在15到8192px之间。
图像中秘鲁身份证区域有效占比超过25%，保证整张秘鲁身份证内容及其边缘包含在图像内。
支持图像中秘鲁身份证任意角度的水平旋转。
支持少量扭曲，扭曲后图像中的秘鲁身份证长宽比与实际秘鲁身份证相差不超过10%。
能处理反光、暗光等干扰的图片但影响识别精度。

调用方法

请参见如何调用API。

前提条件

在使用越南身份证识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。

URI

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

表1 路径参数
参数	是否必选	说明
endpoint	是	终端节点，即调用API的请求地址。不同服务不同区域的endpoint不同，您可以从终端节点中获取。
project_id	是	项目ID，您可以从获取项目ID中获取。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。
Content-Type	是	String	发送的实体的MIME类型，参数值为“application/json”。
Enterprise-Project-Id	否	String	企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。企业项目创建步骤请参见用户指南。说明：创建企业项目后，在传参时，有以下三类场景。携带正确的ID，正常使用OCR服务，账单的企业项目会被分类到企业ID对应的企业项目中。携带格式正确但不存在的ID，正常使用OCR服务，账单的企业项目会显示对应不存在的企业项目ID。不携带ID或格式错误ID（包含特殊字符等），正常使用OCR服务，账单的企业项目会被分类到"default"中。

表3 请求Body参数
参数	是否必选	参数类型	描述
image	否	String	与url二选一。图片的Base64编码，要求base64编码后大小不超过10M。图片最小边不小于15像素，最长边不超过8192像素，支持JPG/PNG/BMP/TIFF/PDF格式，支持识别多页PDF数据。图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。
url	否	String	与image二选一。图片的url路径，目前支持：公网http/https url OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。说明：接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。
return_portrait_image	否	Boolean	是否返回头像内容开关，可选值如下所示： true: 返回身份证头像照片的 base64 编码。 false: 返回为空值。未传入该参数时默认为“false”，即返回为空值。
return_portrait_location	否	Boolean	是否返回头像坐标的开关，可选值如下所示： true: 返回身份证头像的位置坐标。 false: 返回为空值未传入该参数时默认为“false”，即返回为空。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
result	PeruIdCardResult object	调用成功时表示调用结果。调用失败时无此字段。

表5 PeruIdCardResult
参数	参数类型	描述
cui_number	String	身份证号。
first_surname	String	第一姓氏。
second_surname	String	第二姓氏。
given_name	String	名。
sex	String	性别。
marital_status	String	婚姻状况。
birth_date	String	出生日期。
nationality	String	国籍。
issue_date	String	发行日期。
expiry_date	String	失效日期。
birth_place	String	出生地编码。
voting_group	String	投票组。
organ_donation	String	器官捐赠意愿。
registration_date	String	注册日期。
portrait_image	String	头像的base64编码。当输入参数“return_portrait_image”为“true”时，才返回该参数。
portrait_location	Array<Array<Integer>>	头像在原图上的位置。当输入参数“return_portrait_location”为“true”时，才返回该参数。以列表形式显示，包含头像区域四个顶点的二维坐标（x,y），坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。
address	String	地址。
department	String	大区。
province	String	省。
district	String	区。
remarks	String	备注。
machine_code1	String	机器码第一行。
machine_code2	String	机器码第二行。
machine_code3	String	机器码第三行。
duplicate	Boolean	是否重新登记过。可选值如下所示： true: 已重新登记过 false: 未重新登记过
confidence	Map<String,Number>	相关字段的置信度信息，置信度越大，表示本次识别的对应字段的可靠性越高，在统计意义上，置信度越大，准确率越高。注：置信度由算法给出，不直接等价于对应字段的准确率。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	调用失败时的错误码，具体请参见错误码。调用成功时不返回此字段。
error_msg	String	调用失败时返回的错误信息。调用成功时不返回此字段。

请求示例

“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。
例如，秘鲁身份证识别服务部署在“拉美-圣地亚哥”区域的“endpoint”为“ocr.la-south-2.myhuaweicloud.com”或“ocr.la-south-2.myhuaweicloud.cn”，请求URL为“https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/peru-id-card”，“project_id”为项目ID，获取方法请参见获取项目ID
如何获取Token请参见构造请求。

请求示例（方式一：使用图片的Base64编码）

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

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

请求示例（方式二：使用图片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
}

响应示例

状态码： 200

成功响应示例

{
  "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
    }
  }
}

状态码： 400

失败响应示例

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

SDK代码示例

SDK代码示例如下。

使用SDK前建议将SDK更新至最新版，防止本地旧版SDK无法使用最新的OCR功能。

传入秘鲁身份证图片的base64编码进行文字识别

        
         
           
           
             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());
        }
    }
}

            

          

        
       

传入秘鲁身份证图片的url进行文字识别

        
         
           
           
             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());
        }
    }
}

            

          

        
       

传入秘鲁身份证图片的base64编码进行文字识别

        
         
           
           
             # 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)

            

          

        
       

传入秘鲁身份证图片的url进行文字识别

        
         
           
           
             # 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)

            

          

        
       

传入秘鲁身份证图片的base64编码进行文字识别

        
         
           
           
             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)
    }
}

            

          

        
       

传入秘鲁身份证图片的url进行文字识别

        
         
           
           
             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)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	成功响应示例
400	失败响应示例

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： API

上一篇：越南身份证识别

下一篇：泰国车牌识别

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消