身份证识别
功能介绍
识别身份证图片中的文字内容，并将识别的结果以json格式返回给用户，不支持判断身份证的真假。该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。
调试
您可以在API Explorer中调试该接口。
URI
POST https://{endpoint}/v2/{project_id}/ocr/id-card
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，响应消息头中X-Subject-Token的值即为Token。 |
Content-Type |
是 |
String |
发送的实体的MIME类型，参数值为“application/json”。 |
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
image |
否，该参数与url二选一 |
String |
图像数据，base64编码，要求base64编码后大小不超过10MB。图片最小边不小于15px，最长边不超过8000px。支持JPEG、JPG、PNG、BMP、TIFF格式。 |
url |
否，该参数与image二选一 |
String |
图片的url路径，目前支持：
说明：
|
side |
否 |
String |
如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。 |
响应参数
根据识别的结果，可能有不同的HTTP响应状态码（status code），状态码和响应参数说明如下。
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
result |
IDCardResult object |
调用成功时表示调用结果。 调用失败时无此字段。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
姓名。 |
sex |
String |
性别。 |
birth |
String |
出生日期。 |
ethnicity |
String |
民族。 |
address |
String |
地址。 |
number |
String |
身份证号。 |
issue |
String |
发证机关。 |
valid_from |
String |
有效起始日期。 |
valid_to |
String |
有效结束日期。 说明：
身份证识别只支持中国大陆汉族身份证识别。 |
状态码： 400
参数 |
参数类型 |
说明 |
|---|---|---|
error_code |
String |
调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 请求示例（方式一：使用图片的base64编码）
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" }
- 请求示例（方式二：使用图片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" }
- 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)
响应示例
状态码：200
成功响应示例（人像面）
{
"result":{
"name":"张三",
"sex":"男",
"ethnicity":"汉",
"birth":"2000-03-06",
"address":"XX省XX市XX区XX街道XX号",
"number":"610XXXXXXXXXXXXXXX"
}
}
成功响应示例（国徽面）
{
"result":{
"issue": "XX省XX市XX区XX派出所",
"valid_from": "2004-08-26",
"valid_to": "2034-08-26"
}
}
状态码：400
失败响应示例
{
"error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
错误码
错误码请参见错误码。
