文档首页> 文字识别 OCR> API参考> API> 智利身份证识别
更新时间:2023-11-10 GMT+08:00

智利身份证识别

功能介绍

识别智利身份证图片中的文字内容,并将识别的结果以JSON格式返回给用户。该接口的使用限制请参见约束与限制,详细使用指导请参见OCR服务使用简介章节。

图1 智利身份证示例图

约束与限制

  • 只支持识别PNG、JPG、BMP、TIFF格式的图片。
  • 图像各边的像素大小在15到8192px之间。
  • 目前只支持单张智利身份证正面识别。
  • 支持图像中智利身份证任意角度的水平旋转。
  • 能处理反光、暗光等干扰的图片但影响识别精度。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

API Explorer可调用区域为拉美-圣地亚哥。

前提条件

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

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

URI

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

表1 路径参数

参数

是否必选

说明

endpoint

终端节点,即调用API的请求地址。

不同服务不同区域的endpoint不同,您可以从终端节点中获取。

智利身份证识别接口的endpoint为ocr.la-south-2.myhuaweicloud.com。

project_id

项目ID,您可以从获取项目ID中获取。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。

Content-Type

String

发送的实体的MIME类型,参数值为“application/json”。

表3 请求Body参数

参数

是否必选

参数类型

说明

image

String

与url二选一。

图片的Base64编码,图片尺寸不小于15×15像素,最长边不超过8192像素,支持JPG/PNG/BMP/TIFF格式。

图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。

url

String

与image二选一。

图片的url路径,目前支持:

  • 公网http/https url
  • OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限
说明:
  • 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。
  • 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

ChileIdCardResult object

调用结果。

调用失败时不返回此字段。

表5 ChileIdCardResult

参数

参数类型

描述

surname

Array of strings

姓氏。

given_name

String

名。

nationality

String

国籍。

sex

String

性别。

birth

String

出生日。

issue_date

String

发行日。

expiry_date

String

有效期。

document_number

String

文档编号。

number

String

身份证号。

confidence

ChileIdCardConfidence object

字段的置信度,取值范围0~1。

置信度越大,本次识别的字段的可靠性越高,在统计意义上,置信度越大,准确率越高。 置信度由算法给出,不直接等价于字段的准确率。

表6 ChileIdCardConfidence

参数

参数类型

描述

surname

Float

姓氏置信度。

given_name

Float

名置信度。

nationality

Float

国籍置信度。

sex

Float

性别置信度。

birth

Float

出生日置信度。

issue_date

Float

发行日置信度。

expiry_date

Float

有效期置信度。

document_number

Float

文档编号置信度。

number

Float

身份证号置信度。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

当出现错误码“ModelArts.4204”时,请参考为什么调用API时提示“ModelArts.4204”?章节。

调用成功时不返回此字段。

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}/ocr/chile-id-card”“project_id”为项目ID,获取方法请参见获取项目ID

  • 如何获取Token请参见构造请求
  • 请求示例(方式一:使用图片的Base64编码)
    POST https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card
    
    Request Header: 
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    Request Body:
    {
        "image": "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgA..."
    }
  • 请求示例(方式二:使用图片URL)
    POST https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card
    
    Request Header:
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    Request Body: 
    {
        "url":"https://BucketName.obs.xxxx.com/ObjectName"
    }
  • Python3语言请求代码示例(其他语言参照下列示例编写或使用OCR SDK)
    # encoding:utf-8
    
    import requests
    import base64
    
    url = "https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/chile-id-card"
    token = "用户获取得到的实际token值"
    headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
    
    imagepath = r'./data/chile-id-card-demo.png' # 读取本地图片
    with open(imagepath, "rb") as bin_data:
        image_data = bin_data.read()
    image_base64 = base64.b64encode(image_data).decode("utf-8")  # 使用图片的Base64编码
    payload = {"image": image_base64}
    response = requests.post(url, headers=headers, json=payload)
    print(response.text)

响应示例

状态码:200

成功响应示例

{
   "result": {
        "surname": [
            "FERNANDEZ",
            "GATICA"
        ],
        "given_name": "MARCELA CAROLINA",
        "nationality": "CHILENA",
        "sex": "F",
        "birth": "21 FEB 1982",
        "document_number": "100000001",
        "issue_date": "1 SEP 2013",
        "expiry_date": "10 AGO 2023",
        "number": "12.749.625-K",
        "confidence": {
             "surname": 0.9584,
             "given_name": 0.8106,
             "nationality": 0.7026,
             "sex": 0.5879,
             "birth": 0.9305,
             "document_number": 0.8181,
             "issue_date": 0.8518,
             "expiry_date": 0.7757,
             "number": 0.9528
        }
   }
}

状态码:400

失败响应示例

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

状态码

状态码

描述

200

成功响应样例

400

失败响应样例

状态码请参见状态码

错误码

错误码请参见错误码