港澳台居民来往内地通行证识别
功能介绍
识别中国-港澳居民来往内地通行证上的文字内容,并将识别的结构化结果返回给用户。支持中国-港澳居民来往内地通行证和中国-台湾居民来往内地通行证两种卡证。该接口的使用限制请参见约束与限制,详细使用指导请参见OCR服务使用简介章节。
约束与限制
- 只支持识别PNG、JPG、BMP、TIFF格式的图片。
- 图像各边的像素大小在15到8192px之间。
- 图像中通行证区域有效占比超过50%,保证整张通行证内容及其边缘包含在图像内。
- 支持图像任意角度的水平旋转但影响识别精度。
- 能处理反光、暗光等干扰的图片但影响识别精度。
调用方法
请参见如何调用API。
前提条件
在使用该接口之前,需要您完成服务申请和认证鉴权,具体操作流程请参见开通服务和认证鉴权章节。
用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。
URI
POST /v2/{project_id}/ocr/mainland-travel-permit
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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)。
企业项目创建步骤请参见用户指南。 说明:
创建企业项目后,在传参时,有以下三类场景。
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
image |
否 |
String |
与url二选一。 图片的Base64编码,图片尺寸不小于15×15像素,最长边不超过8192像素,支持JPG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。 |
url |
否 |
String |
与image二选一。 图片的url路径,目前支持:
说明:
|
return_portrait_image |
否 |
Boolean |
是否返回头像内容开关,可选值如下所示:
未传入该参数时默认为“false”,即不返回通行证头像照片的 base64 编码。 |
return_portrait_location |
否 |
Boolean |
是否返回头像坐标的开关,可选值如下所示:
未传入该参数时默认为“false”,即不返回通行证的头像坐标。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
MainlandTravelPermitResult object |
调用成功时表示调用结果。 调用失败时无此字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
中文姓名。 |
name_en |
String |
英文姓名。 |
birth_date |
String |
出生日期。 |
sex |
String |
性别。 |
valid_period |
String |
有效期限。 |
issuing_authority |
String |
签发机关。 |
number |
String |
证件号。 |
issue_place |
String |
签发地点。 |
issue_times |
String |
签发次数。 |
id_name |
String |
回乡证背面的中国-香港/中国-澳门/中国-台湾通行证姓名。 |
id_number |
String |
回乡证背面的中国-香港/中国-澳门/中国-台湾通行证号码。 |
machine_code1 |
String |
机读码第一行。 |
machine_code2 |
String |
机读码第二行。 |
machine_code3 |
String |
机读码第三行。 |
type |
String |
证件类别。可选值包括:
|
side |
String |
证件图片正反面信息。可选值包括:
|
portrait_image |
String |
头像的base64编码。当输入参数“return_portrait_image”为“true”时,才返回该参数。 |
portrait_location |
Array<Array<Integer>> |
头像在原图上的位置。 当输入参数“return_portrait_location”为“true”时,才返回该参数。以列表形式显示,包含头像区域四个顶点的二维坐标(x,y),坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。 |
confidence |
各个字段的置信度。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
Float |
中文姓名的置信度。 |
name_en |
Float |
英文姓名的置信度。 |
birth_date |
Float |
出生日期的置信度。 |
sex |
Float |
性别的置信度。 |
valid_period |
Float |
有效期限的置信度。 |
issuing_authority |
Float |
签发机关的置信度。 |
number |
Float |
证件号的置信度。 |
issue_place |
Float |
签发地点的置信度。 |
issue_times |
Float |
签发次数的置信度。 |
type |
Float |
证件类别的置信度。 |
side |
Float |
证件图片正反面信息的置信度。 |
id_name |
Float |
回乡证背面的中国-香港/中国-澳门/中国-台湾通行证姓名的置信度。 |
id_number |
Float |
回乡证背面的中国-香港/中国-澳门/中国-台湾通行证号码的置信度。 |
machine_code1 |
Float |
机读码第一行的置信度。 |
machine_code2 |
Float |
机读码第二行的置信度。 |
machine_code3 |
Float |
机读码第三行的置信度。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码,具体请参见错误码。调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 请求示例(方式一:使用图片的Base64编码)
POST https://{endpoint}/v2/{project_id}/ocr/mainland-travel-permit Request Header: Content-Type: application/json, X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image": "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgA..." "return_portrait_image": True, "return_portrait_location": True }
- 请求示例(方式二:使用图片URL)
POST https://{endpoint}/v2/{project_id}/ocr/mainland-travel-permit Request Header: Content-Type: application/json, X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url": "https://BucketName.obs.xxxx.com/ObjectName", "return_portrait_image": True, "return_portrait_location": True }
响应示例
状态码: 200
成功响应样例
{ "result" : { "name" : "张三", "name_en" : "ZHANG, SAN", "birth_date" : "1992.10.11", "sex" : "男", "valid_period" : "1992.10.11-2002.04.04", "issuing_authority" : "中华人民共和国出入境管理局", "number" : "E23xxxxxx", "issue_times" : "00", "type" : "港澳居民来往内地通行证", "side" : "front", "confidence" : { "name" : 0.9999, "name_en" : 0.9868, "birth_date" : 0.9984, "sex" : 0.9999, "valid_period" : 0.9988, "issuing_authority" : 0.9998, "number" : 0.9999, "issue_times" : 0.9997, "type" : 0.9999, "side" : 1.0 } } }
状态码: 400
失败响应样例
{ "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }
SDK代码示例
SDK代码示例如下。
- 传入中国-港澳台居民来往内地通行证图片的base64编码进行文字识别
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
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 RecognizeMainlandTravelPermitSolution { 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(); RecognizeMainlandTravelPermitRequest request = new RecognizeMainlandTravelPermitRequest(); MainlandTravelPermitRequestBody body = new MainlandTravelPermitRequestBody(); body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."); request.withBody(body); try { RecognizeMainlandTravelPermitResponse response = client.recognizeMainlandTravelPermit(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进行文字识别
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
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 RecognizeMainlandTravelPermitSolution { 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(); RecognizeMainlandTravelPermitRequest request = new RecognizeMainlandTravelPermitRequest(); MainlandTravelPermitRequestBody body = new MainlandTravelPermitRequestBody(); body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName"); request.withBody(body); try { RecognizeMainlandTravelPermitResponse response = client.recognizeMainlandTravelPermit(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编码进行文字识别
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
# 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 = RecognizeMainlandTravelPermitRequest() request.body = MainlandTravelPermitRequestBody( image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." ) response = client.recognize_mainland_travel_permit(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进行文字识别
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
# 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 = RecognizeMainlandTravelPermitRequest() request.body = MainlandTravelPermitRequestBody( url="https://BucketName.obs.myhuaweicloud.com/ObjectName" ) response = client.recognize_mainland_travel_permit(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编码进行文字识别
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
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.RecognizeMainlandTravelPermitRequest{} imageMainlandTravelPermitRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." request.Body = &model.MainlandTravelPermitRequestBody{ Image: &imageMainlandTravelPermitRequestBody, } response, err := client.RecognizeMainlandTravelPermit(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
- 传入中国-港澳台居民来往内地通行证图片的url进行文字识别
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
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.RecognizeMainlandTravelPermitRequest{} urlMainlandTravelPermitRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName" request.Body = &model.MainlandTravelPermitRequestBody{ Url: &urlMainlandTravelPermitRequestBody, } response, err := client.RecognizeMainlandTravelPermit(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功响应样例 |
400 |
失败响应样例 |
状态码请参见状态码。
错误码
错误码请参见错误码。