身份证识别
URL
POST https://{endpoint}/v1.0/ocr/id-card
参数 |
是否必选 |
说明 |
|---|---|---|
endpoint |
是 |
指定承载REST服务端点的服务器域名或IP，不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 |
请求消息
身份证识别请求参数说明请参见表2。
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
image |
否，该参数与url二选一 |
String |
图像数据，base64编码，要求base64编码后大小不超过10MB。图片最小边不小于15px，最长边不超过8000px。支持JPEG、JPG、PNG、BMP、TIFF格式。 |
url |
否，该参数与image二选一 |
String |
图片的url路径，目前支持：
说明：
|
side |
否 |
String |
如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。 |
响应消息
身份证识别响应参数说明请参见表3。
参数 |
参数类型 |
说明 |
|---|---|---|
result |
Object |
调用成功时表示调用结果。 调用失败时无此字段。 |
name |
String |
姓名。 |
sex |
String |
性别。 |
birth |
String |
出生日期。 |
ethnicity |
String |
民族。 |
address |
String |
住址。 |
number |
String |
身份证号。 |
issue |
String |
发证机关。 |
valid_from |
String |
有效期限起始日期。 |
valid_to |
String |
有效期限结束日期。 |
error_code |
String |
调用失败时的错误码，具体请参见错误码。 当出现错误码“ModelArts.4204”时，请参考为什么调用API时提示“ModelArts.4204”？章节。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
示例
“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。
例如身份证识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v1.0/ocr/id-card”。
- 请求示例（方式一：使用图片的base64编码）
POST https://{endpoint}/v1.0/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}/v1.0/ocr/id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.myhwclouds.com/ObjectName", "side":"front" }
- Python语言请求代码示例（其他语言参照下列示例编写或使用OCR SDK）
# encoding:utf-8 import requests import base64 url = "https://{endpoint}/v1.0/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) - 成功响应示例（人像面）
{ "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" } } - 失败响应示例
{ "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
相关文档
相关产品
