ocr
身份证识别
更新时间：
2020/01/16 GMT+08:00
功能介绍
文字识别OCR的身份证识别用于识别用户上传的身份证图片（或者用户提供的华为云上OBS的身份证图片文件的URL）中的文字内容，并将识别的结果返回给用户。
URI
URI格式：
POST /v1.0/ocr/id-card
请求消息
身份证识别请求参数说明请参见表1。
响应消息
身份证识别响应参数说明请参见表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." }
状态码
状态码请参见状态码。
父主题：
API
相关文档
相关产品
