# 身份证识别 用于识别用户上传的身份证图片中的文字内容，并将识别的结果返回给用户。 身份证识别只支持中国大陆身份证识别。 ## 请求格式说明 ** 调试工具：** 在线调试

请求方式：POST (HTTPS)

请求地址：

https://open.welink.huaweicloud.com/api/aiservice/v1/ocr/id-card

认证方式： access_token，请参考获取access_token

请求头部：

Content-Type: application/json    
x-wlk-Authorization: access_token

请求参数

{ 
    "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", 
    "side":"front" 
}

请求参数说明

参数 必选 参数类型 说明
image 是 String 图像数据，base64编码，要求base64编码后大小不超过10M。图片最小边不小于15像素，最长边不超过8000像素。支持JPG/PNG/BMP/TIFF格式。
side 否 String front：身份证正面 back：身份证背面 如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。

请求示例 

 curl -X POST \
  'https://open.welink.huaweicloud.com/api/aiservice/v1/ocr/id-card' \
  -H 'Accept-Charset: UTF-8' \
  -H 'Content-Type: application/json' \
  -H 'x-wlk-Authorization: access_token' \
  -d '{"image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "side":"front"}'

响应格式说明

返回结果 正常返回结果

  • 成功响应示例(正面)

    {
  "code": "0",
  "data": {
      "name":"张三", 
      "sex":"男", 
      "ethnicity":"汉", 
      "birth":"2000-03-06", 
      "address":"XX省XX市XX区XX街道XX号", 
      "number":"610XXXXXXXXXXXXXXX"  
  },
  "error": "",
  "message": "ok"
}

  • 成功响应示例（背面）

    {
  "code": "0",
  "data": {
      "issue": "XX省XX市XX区XX派出所",  
      "valid_from": "2004-08-26", 
      "valid_to": "2034-08-26"  
  },
  "error": "",
  "message": "ok"
}

    异常返回结果

  • Token验证失败响应示例
    {
  "code": "58401",
  "data": null,
  "error": "Failed to verify the token.",
  "message": "Login authentication failed."
}

返回参数说明
身份证识别响应参数说明请参见表。

  • 响应参数说明
参数 必选 参数类型 说明
code 是 String 错误码
message 是 String 调用成功时为"ok"。调用失败时的错误信息。
data 是 Object 调用成功时表示调用结果，详见data数据结构。调用失败时为null。
error 是 String 错误信息。

data 数据结构

参数 必选 参数类型 说明
name 否 String 姓名。
sex 否 String 性别。
birth 否 String 出生日期。
ethnicity 否 String 民族。
address 否 String 地址。
number 否 String 身份证号。
issue 否 String 发证机关。
valid_from 否 String 有效起始日期。
valid_to 否 String 有效结束日期。

错误码说明

错误码 说明
0 成功。
58401 无权限。
58402 非法输入参数。
58500 服务异常。
58001 OCR服务异常。

结果。 ""

    无结果。 ""