文档首页 > > API参考> API> 身份证识别

身份证识别

分享
更新时间: 2019/10/30 GMT+08:00

功能介绍

文字识别OCR身份证识别用于识别用户上传的身份证图片(或者用户提供的华为云上OBS的身份证图片文件的URL)中的文字内容,并将识别的结果返回给用户。

身份证识别只支持中国大陆汉族身份证识别

如果图片中包含多张卡证票据,请调用智能分类识别服务。

URI

URI格式:

POST /v1.0/ocr/id-card

请求消息

身份证识别请求参数说明请参见表1

表1 请求参数说明

参数

是否必选

参数类型

说明

image

与url二选一

String

图像数据,base64编码,要求base64编码后大小不超过10M。图片最小边不小于15像素,最长边不超过8000像素。支持JPEG/JPG/PNG/BMP/TIFF格式。

url

与image二选一

String

图片的URL路径,目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。

side

String

  • front:身份证正面
  • back:身份证背面

如果参数值为空或无该参数,系统自动识别,建议填写,准确率更高。

响应消息

身份证识别响应参数说明请参见表2

表2 响应参数说明

参数

参数类型

说明

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

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

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

  • 请求示例(方式一:使用图片的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"
      }

Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点

例如身份证识别服务部署在“华北-北京四”区域的Endpoint为“ocr.cn-north-4.myhuaweicloud.com”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v1.0/ocr/id-card”。

  • 成功响应示例(正面)
    {
      "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."
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区