柬文身份证识别
约束与限制
- 目前只支持单张柬文身份证正面识别。
- 只支持识别PNG、JPG、BMP、TIFF格式的图片。
- 图像各边的像素大小在15到8192px之间。
- 支持图像中柬文身份证任意角度的水平旋转。
- 能处理反光、暗光等干扰的图片但影响识别精度。
调用方法
请参见如何调用API。
前提条件
在使用柬文身份证识别之前,需要您完成服务申请和认证鉴权,具体操作流程请参见开通服务和认证鉴权章节。
用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。
URI
POST /v2/{project_id}/ocr/cambodian-idcard
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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像素,最长边不超过8192像素,支持JPG/PNG/BMP/TIF格式。 |
url |
否 |
String |
与image二选一。 图片的url路径,目前支持:
说明:
|
return_portrait_image |
否 |
Boolean |
是否返回头像内容开关,可选值如下所示:
|
return_portrait_location |
否 |
Boolean |
是否返回头像坐标的开关,可选值如下所示:
|
return_idcard_type |
否 |
Boolean |
是否返回身份证类型的开关,可选值如下所示:
|
detect_border_integrity |
否 |
Boolean |
返回身份证边框完整性的告警结果的开关,可选值如下所示:
|
detect_blocking_within_border |
否 |
Boolean |
返回身份证内部是否有被遮挡的告警结果的开关,可选值如下所示:
|
detect_blur |
否 |
Boolean |
返回身份证模糊告警结果的开关,可选值如下所示:
|
detect_glare |
否 |
Boolean |
返回身份证是否反光的告警结果的开关,可选值如下所示:
|
return_adjusted_image |
否 |
Boolean |
返回身份证四点原图的base64编码
|
detect_tampering |
否 |
Boolean |
返回身份证人像是否被篡改的告警结果的开关,可选值如下所示:
不支持精细化的P图 |
detect_reproduce |
否 |
Boolean |
返回判断身份证图像是否经过翻拍告警的开关,可选值如下所示:
|
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
CambodianIdCardResult object |
识别结果。 调用失败时此字段为空。 |
参数 |
参数类型 |
描述 |
---|---|---|
id_number |
String |
身份证号码。 |
name_kh |
String |
高棉语版姓名。 |
name_en |
String |
英文姓名。 |
birth_date |
String |
出生日期。 |
sex |
String |
性别。 |
height |
String |
身高。 |
birth_place |
String |
出生地。 |
address |
String |
地址,以空格分隔。 |
issue_date |
String |
签发起始日期。 |
expiry_date |
String |
签发结束日期。 |
description |
String |
图片中的个人特征。 |
machine_code1 |
String |
机器码第一行。 |
machine_code2 |
String |
机器码第二行。 |
machine_code3 |
String |
机器码第三行。 |
portrait_image |
String |
头像的base64编码。 当输入参数“return_portrait_image”为“true”时,才返回该参数。 |
portrait_location |
Array<Array<Integer>> |
头像在原图上的位置。 当输入参数“return_portrait_location”为“true”时,才返回该参数。以列表形式显示,包含头像区域四个顶点的二维坐标(x,y),坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。 |
idcard_type |
String |
身份证的类型。当输入参数“ idcard_type ”为“true”时,才返回该参数。取值如下所示:
|
adjusted_image |
String |
身份证原图的base64编码。 当输入参数"return_adjusted_image"为"true"时,才返回该参数。 |
detect_border_integrity_result |
Boolean |
身份证图片边框完整性告警结果,"true"表示边框不完整,"false"表示边框完整。仅在输入参数detect_border_integrity为true时,返回该字段。 |
detect_blocking_within_border_result |
Boolean |
身份证图像框内是否存在遮挡的告警结果,"true"表示边框内部存在遮挡,"false"表示边框内部完整。仅在输入参数detect_blocking_within_border为true时,返回该字段。 |
detect_blur_result |
Boolean |
身份证模糊告警结果,"true"表示图片模糊,"false"表示身份证清晰。仅在输入参数detect_blur为true时,返回该字段。 |
detect_glare_result |
Boolean |
身份证反光告警结果,"true"表示身份证反光,"false"表示是身份证无反光。仅在输入参数detect_glare为true时,返回该字段。 |
detect_tampering_result |
Boolean |
身份证人像被篡改的告警结果,"true"表示身份证人像被篡改,"false"表示是身份证人像未被篡改。仅在输入参数detect_tampering为true时,返回该字段。 |
detect_reproduce_result |
Boolean |
身份证是否经过翻拍的告警结果,“true”表示身份证经过翻拍,“false”表示身份证未经过翻拍。仅在输入参数detect_reproduce为true时,返回该字段。 |
score_info |
告警分数,包含字段:idcard_type_score、border_integrity_score、blocking_within_border_score、blur_score、glare_score、tampering_score、reproduce_score以上字段取值范围为[0, 99]。 |
|
confidence |
Object |
字段的置信度,取值范围0~1。 置信度越大,本次识别的字段的可靠性越高,在统计意义上,置信度越大,准确率越高。 置信度由算法给出,不直接等价于字段的准确率。 |
参数 |
参数类型 |
描述 |
---|---|---|
idcard_type_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示复印件,小于等于50表示原件,值越靠近99,表示复印件的可能性越大,值越靠近0,表示原件的可能性越大。 仅在传入参数return_idcard_type为true时,返回该字段。 |
border_integrity_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示边框不完整,小于50表示边框完整,值越靠近99,表示边框不完整的可能性越大,值越靠近0,表示边框完整的可能性越大。 仅在传入参数detect_border_integrity为true时,返回该字段。 |
blocking_within_border_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示框内有遮挡,小于50表示框内无遮挡,值越靠近99,表示框内有遮挡的可能性越大,值越靠近0,表示框内无遮挡的可能性越大。 仅在传入参数detect_blocking_within_border为true时,返回该字段。 |
blur_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示身份证模糊,小于50表示身份证清晰,值越靠近99,表示身份证模糊的可能性越大,值越靠近0,表示身份证清晰的可能性越大。 仅在传入参数detect_blur为true时,返回该字段。 |
glare_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示身份证反光,小于50表示身份证不反光,值越靠近99,表示身份证反光的可能性越大,值越靠近0,表示身份证不反光的可能性越大。 仅在传入参数detect_glare为true时,返回该字段。 |
tampering_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示身份证人像被其他非身份证人像篡改过,小于50表示身份证人像未被篡改,值越靠近99,表示身份证人像被篡改的可能性越大,值越靠近0,表示身份证未人像被篡改的可能性越大。仅在传入参数detect_tampering为true时,返回该字段。 |
reproduce_score |
Integer |
告警分数,字段取值范围[0, 99]值大于50表示身份证经过翻拍,小于50表示身份证未经过翻拍,值越靠近99,表示身份证图像被翻拍过的可能性越大,值越靠近0,表示身份证图像未被翻拍的可能性越大。仅在传入参数detect_reproduce为true时,返回该字段。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码,具体请参见错误码。 调用成功时不返回此字段。 |
error_msg |
String |
调用失败时返回的错误信息。 调用成功时不返回此字段。 |
请求示例
- 请求示例(方式一:使用图片的Base64编码)
POST https://{endpoint}/v2/{project_id}/ocr/cambodian-idcard Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." }
- 请求示例(方式二:使用图片url)
POST https://{endpoint}/v2/{project_id}/ocr/cambodian-idcard Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.myhwclouds.com/ObjectName" }
响应示例
状态码:200
成功响应示例
{ "result": { "id_number": "XXXXX", "name_kh": "យឹXXXXX", "name_en": "YOENG THXXXXX", "birth_date": "១០.០៧.១៩៩៩", "sex": "ស្រី", "height": "១៥៨ ស.ម", "birth_place": "XXXXX", "address": " XXXXX", "issue_date": "១៥.១២.២០១៥", "expiry_date": "១៤.១២.២០២៥", "description": "XXXXXX", "machine_code1": "IDKHM040XXXXXXX<<<<<<<<<<<<<<<", "machine_code2": "990XXX2F25XXXXXXX<<<<<<<<<<<2", "machine_code3": "YOENG<<THXXXXX<<<<<<<<<<<<<<<", "idcard_type": "normal", "confidence": { "id_number": 0.8345, "name_kh": 0.8721, "name_en": 0.7191, "birth_date": 0.7749, "sex": 0.8216, "height": 0.6493, "birth_place": 0.8282, "address": 0.91185, "issue_date": 0.7509, "expiry_date": 0.7983, "description": 0.9091, "machine_code1": 0.9047, "machine_code2": 0.9292, "machine_code3": 0.898, "idcard_type": 0.998 }, "portrait_image": "/9j/4AA…. ", "portrait_location": [ [ 53, 341 ], [ 185, 340 ], [ 179, 504 ], [ 42, 505 ] ] } }
状态码:400
失败响应示例
{ "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }
SDK代码示例
SDK代码示例如下。
使用SDK前建议将SDK更新至最新版,防止本地旧版SDK无法使用最新的OCR功能。
- 传入柬文身份证图片的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 RecognizeCambodianIdCardSolution { 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(); RecognizeCambodianIdCardRequest request = new RecognizeCambodianIdCardRequest(); CambodianIdCardRequestBody body = new CambodianIdCardRequestBody(); body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."); request.withBody(body); try { RecognizeCambodianIdCardResponse response = client.recognizeCambodianIdCard(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 RecognizeCambodianIdCardSolution { 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(); RecognizeCambodianIdCardRequest request = new RecognizeCambodianIdCardRequest(); CambodianIdCardRequestBody body = new CambodianIdCardRequestBody(); body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName"); request.withBody(body); try { RecognizeCambodianIdCardResponse response = client.recognizeCambodianIdCard(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 = RecognizeCambodianIdCardRequest() request.body = CambodianIdCardRequestBody( image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." ) response = client.recognize_cambodian_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进行文字识别
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 = RecognizeCambodianIdCardRequest() request.body = CambodianIdCardRequestBody( url="https://BucketName.obs.myhuaweicloud.com/ObjectName" ) response = client.recognize_cambodian_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编码进行文字识别
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.RecognizeCambodianIdCardRequest{} imageCambodianIdCardRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." request.Body = &model.CambodianIdCardRequestBody{ Image: &imageCambodianIdCardRequestBody, } response, err := client.RecognizeCambodianIdCard(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.RecognizeCambodianIdCardRequest{} urlCambodianIdCardRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName" request.Body = &model.CambodianIdCardRequestBody{ Url: &urlCambodianIdCardRequestBody, } response, err := client.RecognizeCambodianIdCard(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功响应示例 |
400 |
失败响应示例 |
状态码请参见状态码。
错误码
错误码请参见错误码。