功能介绍
识别身份证图片中的文字内容，并将识别的结果以json格式返回给用户，不支持判断 身份证的真假。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务
使用简介章节。
图4-6 身份证识别示例图
说明
身份证识别支持中华人民共和国居民身份证识别。
如果图片中包含多张卡证票据，请调用智能分类识别服务。
调试
您可以在API Explorer中调试该接口。
前提条件
在使用身份证识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通
服务和认证鉴权章节。
说明
用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通 服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注 意开通服务区域与调用服务的区域保持一致。
URI
POST https://{endpoint}/v2/{project_id}/ocr/id-card
表4-39 路径参数
参数 是否必选 说明
endpoint 是 指定承载REST服务端点的服务器域名或IP，不同 服务不同区域的endpoint不同，您可以从终端节
点中获取。
例如，OCR服务在“华北-北京四”区域的
“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。
project_id 是 项目ID，您可以从获取项目ID中获取。
请求参数
表4-40 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
用于获取操作API的权限。获取 Token接口响应消息头中X-Subject-Token的值即为Token。
Content-Type 是 String 发送的实体的MIME类型，参数 值为“application/json”。
表4-41 请求 Body 参数
参数 是否必选 参数类
型
说明
image 否 String 该参数与url二选一。图像数据，base64编 码，要求base64编码后大小不超过10MB。
图片最小边不小于15px，最长边不超过 8000px。支持JPEG、JPG、PNG、BMP、
TIFF格式。
url 否 String 该参数与image二选一。图片的url路径，目 前支持：
● 公网http/https url
● OBS提供的url，使用OBS数据需要进行授 权。包括对服务授权、临时授权、匿名公 开授权，详情参见配置OBS访问权限。
说明
● 接口响应时间依赖于图片的下载时间，如果图 片下载时间过长，会返回接口调用失败。
● 请保证被检测图片所在的存储服务稳定可靠，
推荐使用OBS服务存储图片数据。
参数 是否必选 参数类 型
说明
side 否 String ● front：身份证人像面
● back：身份证国徽面
如果参数值为空或无该参数，系统自动识 别，建议填写，准确率更高。
return_verif
ication 否 Boolean 返回校验身份证号等信息的开关，默认 false，可选值如下所示：
● true：返回校验信息
● false：不返回校验信息
响应参数
说明
根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成 功，400表示调用失败，详细的状态码和响应参数说明如下。
状态码： 200
表4-42 响应 Body 参数
参数 参数类型 描述
result IDCardRes
ult object 调用成功时表示调用结果。
调用失败时无此字段。
表4-43 IdCardResult
参数 参数类型 描述
name String 姓名。
sex String 性别。
birth String 出生日期。
ethnicity String 民族。
address String 地址。
number String 身份证号。
issue String 发证机关。
valid_from String 有效起始日期。
参数 参数类型 描述
valid_to String 有效结束日期。
说明
身份证识别只支持中国大陆汉族身份证识别。
verification_re
sult IdcardVerific ationResult object
校验信息。仅在输入参数return_verification为 true时，返回该字段，该字段包含
valid_number、valid_birth、valid_sex和 valid_date的校验信息。
表4-44 IdcardVerificationResult
参数 参数类型 描述
valid_number Boolean 身份证号规则校验是否通过。
● true：表示身份证号规则校验通过。
● false：表示身份证号规则校验不通过。
当身份证图片是国徽面时，默认是false。
仅在输入参数return_verification为true时，返回 该字段。
valid_birth Boolean 出生日期与身份证号所表示的出生日期是否一 致。
● true：表示一致。
● false：表示不一致。
当身份证图片是国徽面，或者身份证号规则校验 不通过时，默认是false。
仅在输入参数return_verification为true时，返回 该字段。
valid_sex Boolean 性别与身份证号所表示的性别信息是否一致。
true：表示一致。
false：表示不一致。
当身份证图片是国徽面，或者身份证号规则校验 不通过时，默认是false。
仅在输入参数return_verification为true时，返回 该字段。
valid_date Boolean 当前日期是否在有效期内。
true：表示当前日期在有效期内。
false：表示当前日期不在有效期内。
当身份证图片是人像面时，默认是false。
仅在输入参数return_verification为true时，返回 该字段。
状态码： 400
表4-45 响应 Body 参数
参数 参数类型 说明
error_code String 调用失败时的错误码，具体请参见错误码。
当出现错误码“ModelArts.4204”时，请参考为
什么调用API时提示“ModelArts.4204”？章
节。调用成功时无此字段。
error_msg String 调用失败时的错误信息。
调用成功时无此字段。
POST https://{endpoint}/v2/{project_id}/ocr/id-card Request Header:
Content-Type: application/json X-Auth-Token:
MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{ "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "side":"front",
"return_verification ": true }
● 请求示例（方式二：使用图片URL）
POST https://{endpoint}/v2/{project_id}/ocr/id-card Request Header:
Content-Type: application/json X-Auth-Token:
MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
Request Body:
{ "url":"https://BucketName.obs.myhuaweicloud.com/ObjectName", "side":"front",
"return_verification ": true }
● Python3语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK）
# encoding:utf-8 import requests import base64
url = "https://{endpoint}/v2/{project_id}/ocr/id-card"
token = "用户获取得到的实际token值"
headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
imagepath = r'./data/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} # url与image参数二选一
response = requests.post(url, headers=headers, json=payload) print(response.text) "birth":"2000-03-06",
"address":"XX省XX市XX区XX街道XX号", "number":"610XXXXXXXXXXXXXXX", "verification_result":{
"valid_number": true,
{ "error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
状态码
状态码 描述
200 成功响应。
400 失败响应。
状态码请参见状态码。
错误码
错误码请参见错误码。