身份证识别

更新时间：2024-09-04

接口描述

支持对二代居民身份证正反面所有8个字段进行结构化识别，包括姓名、性别、民族、出生日期、住址、身份证号、签发机关、有效期限，识别准确率超过99%；同时支持身份证正面头像检测，并返回头像切片的base64编码及位置信息。

同时，支持对用户上传的身份证图片进行图像质量和风险检测，是否存在正反颠倒、模糊、欠曝、过曝等质量问题，可识别图片是否为复印件或临时身份证，是否被翻拍或编辑，是否存在四角不完整、头像或关键字段被遮挡。

增值能力	详情
裁剪能力	头像检测与切片：返回头像切片的base64编码及位置信息
裁剪能力	身份证检测与切片：返回身份证的base64编码及位置信息（去掉证件外围多余背景、自动矫正拍摄角度）
质量检测	身份证图片模糊检测
	身份证关键字段反光或过曝光
	身份证图片较暗或欠曝光
	身份证边框/四角不完整告警
	身份证头像或关键字段被遮挡/马赛克告警
风险检测	身份证复印件告警
	临时身份证告警
	身份证翻拍告警
	身份证PS编辑告警
	身份证证号不合法告警
	身份证证号和出生日期、性别信息不一致告警

视频教程请参见身份证识别API调用教程（视频版）

在线调试

您可以在示例代码中心中调试该接口，可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。

请求说明

请求示例

HTTP 方法：POST

请求URL： https://aip.baidubce.com/rest/2.0/ocr/v1/idcard

URL参数：

参数	值
access_token	通过API Key和Secret Key获取的access_token,参考“Access Token获取”

Header如下：

参数	值
Content-Type	application/x-www-form-urlencoded

Body中放置请求参数，参数详情如下：

请求参数

参数	是否必选	类型	可选值范围	说明
image	和url二选一	string	-	图像数据，base64编码后进行urlencode，需去掉编码头（data:image/jpeg;base64, ）要求base64编码和urlencode后大小不超过8M，最短边至少15px，最长边最大8192px，支持jpg/jpeg/png/bmp格式
url	和image二选一	string	-	图片完整URL，URL长度不超过1024字节，URL对应的图片base64编码后大小不超过8M，最短边至少15px，最长边最大8192px，支持jpg/jpeg/png/bmp格式，当image字段存在时url字段失效请注意关闭URL防盗链
id_card_side	是	string	front/back	-front：身份证含照片的一面 -back：身份证带国徽的一面自动检测身份证正反面，如果传参指定方向与图片相反，支持正常识别，返回参数image_status字段为"reversed_side"
detect_ps	否	string	true/false	是否检测上传的身份证被PS，默认不检测。可选值： -true：检测 - false：不检测
detect_risk	否	string	true/false	是否开启身份证风险类型（身份证复印件、临时身份证、身份证翻拍、修改过的身份证）检测功能，默认不开启，即：false。 - true：开启，请查看返回参数risk_type； - false：不开启
detect_quality	否	string	true/false	是否开启身份证质量类型（清晰模糊、边框/四角不完整、头像或关键字段被遮挡/马赛克）检测功能，默认不开启，即：false。 - true：开启，请查看返回参数card_quality； - false：不开启
detect_photo	否	string	true/false	是否检测头像内容，默认不检测。可选值：true-检测头像并返回头像的 base64 编码及位置信息
detect_card	否	string	true/false	是否检测身份证进行裁剪，默认不检测。可选值：true-检测身份证并返回证照的 base64 编码及位置信息
detect_direction	否	string	true/false	是否检测上传的身份证图片方向，默认不检测。可选值： -true：检测 - false：不检测

请求代码示例

提示一：使用示例代码前，请记得替换其中的示例Token、图片地址或Base64信息。

提示二：部分语言依赖的类或库，请在代码注释中查看下载地址。

curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/idcard?access_token=【调用鉴权接口获取的token】' --data 'id_card_side=front&image=【图片Base64编码，需UrlEncode】' -H 'Content-Type:application/x-www-form-urlencoded'

# encoding:utf-8

import requests
import base64

'''
身份证识别
'''

request_url = "https://aip.baidubce.com/rest/2.0/ocr/v1/idcard"
# 二进制方式打开图片文件
f = open('[本地文件]', 'rb')
img = base64.b64encode(f.read())

params = {"id_card_side":"front","image":img}
access_token = '[调用鉴权接口获取的token]'
request_url = request_url + "?access_token=" + access_token
headers = {'content-type': 'application/x-www-form-urlencoded'}
response = requests.post(request_url, data=params, headers=headers)
if response:
    print (response.json())

package com.baidu.ai.aip;

import com.baidu.ai.aip.utils.Base64Util;
import com.baidu.ai.aip.utils.FileUtil;
import com.baidu.ai.aip.utils.HttpUtil;

import java.net.URLEncoder;

/**
* 身份证识别
*/
public class Idcard {

    /**
    * 重要提示代码中所需工具类
    * FileUtil,Base64Util,HttpUtil,GsonUtils请从
    * https://ai.baidu.com/file/658A35ABAB2D404FBF903F64D47C1F72
    * https://ai.baidu.com/file/C8D81F3301E24D2892968F09AE1AD6E2
    * https://ai.baidu.com/file/544D677F5D4E4F17B4122FBD60DB82B3
    * https://ai.baidu.com/file/470B3ACCA3FE43788B5A963BF0B625F3
    * 下载
    */
    public static String idcard() {
        // 请求url
        String url = "https://aip.baidubce.com/rest/2.0/ocr/v1/idcard";
        try {
            // 本地文件路径
            String filePath = "[本地文件路径]";
            byte[] imgData = FileUtil.readFileByBytes(filePath);
            String imgStr = Base64Util.encode(imgData);
            String imgParam = URLEncoder.encode(imgStr, "UTF-8");

            String param = "id_card_side=" + "front" + "&image=" + imgParam;

            // 注意这里仅为了简化编码每一次请求都去获取access_token，线上环境access_token有过期时间， 客户端可自行缓存，过期后重新获取。
            String accessToken = "[调用鉴权接口获取的token]";

            String result = HttpUtil.post(url, accessToken, param);
            System.out.println(result);
            return result;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    public static void main(String[] args) {
        Idcard.idcard();
    }
}

#include <iostream>
#include <curl/curl.h>

// libcurl库下载链接：https://curl.haxx.se/download.html
// jsoncpp库下载链接：https://github.com/open-source-parsers/jsoncpp/
const static std::string request_url = "https://aip.baidubce.com/rest/2.0/ocr/v1/idcard";
static std::string idcard_result;
/**
 * curl发送http请求调用的回调函数，回调函数中对返回的json格式的body进行了解析，解析结果储存在全局的静态变量当中
 * @param 参数定义见libcurl文档
 * @return 返回值定义见libcurl文档
 */
static size_t callback(void *ptr, size_t size, size_t nmemb, void *stream) {
    // 获取到的body存放在ptr中，先将其转换为string格式
    idcard_result = std::string((char *) ptr, size * nmemb);
    return size * nmemb;
}
/**
 * 身份证识别
 * @return 调用成功返回0，发生错误返回其他错误码
 */
int idcard(std::string &json_result, const std::string &access_token) {
    std::string url = request_url + "?access_token=" + access_token;
    CURL *curl = NULL;
    CURLcode result_code;
    int is_success;
    curl = curl_easy_init();
    if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, url.data());
        curl_easy_setopt(curl, CURLOPT_POST, 1);
        curl_httppost *post = NULL;
        curl_httppost *last = NULL;
        curl_formadd(&post, &last, CURLFORM_COPYNAME, "id_card_side", CURLFORM_COPYCONTENTS, "front", CURLFORM_END);
        curl_formadd(&post, &last, CURLFORM_COPYNAME, "image", CURLFORM_COPYCONTENTS, "【base64_img】", CURLFORM_END);

        curl_easy_setopt(curl, CURLOPT_HTTPPOST, post);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, callback);
        result_code = curl_easy_perform(curl);
        if (result_code != CURLE_OK) {
            fprintf(stderr, "curl_easy_perform() failed: %s\n",
                    curl_easy_strerror(result_code));
            is_success = 1;
            return is_success;
        }
        json_result = idcard_result;
        curl_easy_cleanup(curl);
        is_success = 0;
    } else {
        fprintf(stderr, "curl_easy_init() failed.");
        is_success = 1;
    }
    return is_success;
}

<?php
/**
 * 发起http post请求(REST API), 并获取REST请求的结果
 * @param string $url
 * @param string $param
 * @return - http response body if succeeds, else false.
 */
function request_post($url = '', $param = '')
{
    if (empty($url) || empty($param)) {
        return false;
    }

    $postUrl = $url;
    $curlPost = $param;
    // 初始化curl
    $curl = curl_init();
    curl_setopt($curl, CURLOPT_URL, $postUrl);
    curl_setopt($curl, CURLOPT_HEADER, 0);
    // 要求结果为字符串且输出到屏幕上
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
    // post提交方式
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $curlPost);
    // 运行curl
    $data = curl_exec($curl);
    curl_close($curl);

    return $data;
}

$token = '[调用鉴权接口获取的token]';
$url = 'https://aip.baidubce.com/rest/2.0/ocr/v1/idcard?access_token=' . $token;
$img = file_get_contents('[本地文件路径]');
$img = base64_encode($img);
$bodys = array(
    'id_card_side' => "front",
    'image' => $img
);
$res = request_post($url, $bodys);

var_dump($res);

using System;
using System.IO;
using System.Net;
using System.Text;
using System.Web;

namespace com.baidu.ai
{
    public class Idcard
    {
        // 身份证识别
        public static string idcard()
        {
            string token = "[调用鉴权接口获取的token]";
            string host = "https://aip.baidubce.com/rest/2.0/ocr/v1/idcard?access_token=" + token;
            Encoding encoding = Encoding.Default;
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(host);
            request.Method = "post";
            request.KeepAlive = true;
            // 图片的base64编码
            string base64 = getFileBase64("[本地图片文件]");
            String str = "id_card_side=" + "front" + "&image=" + HttpUtility.UrlEncode(base64);
            byte[] buffer = encoding.GetBytes(str);
            request.ContentLength = buffer.Length;
            request.GetRequestStream().Write(buffer, 0, buffer.Length);
            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
            StreamReader reader = new StreamReader(response.GetResponseStream(), Encoding.Default);
            string result = reader.ReadToEnd();
            Console.WriteLine("身份证识别:");
            Console.WriteLine(result);
            return result;
        }

        public static String getFileBase64(String fileName) {
            FileStream filestream = new FileStream(fileName, FileMode.Open);
            byte[] arr = new byte[filestream.Length];
            filestream.Read(arr, 0, (int)filestream.Length);
            string baser64 = Convert.ToBase64String(arr);
            filestream.Close();
            return baser64;
        }
    }
}

返回说明

返回参数

字段	是否必选	类型	说明
log_id	是	uint64	唯一的log id，用于问题定位
words_result	是	array[]	定位和识别结果数组
words_result_num	是	uint32	识别结果数，表示words_result的元素个数
direction	否	int32	图像方向，输入参数 detect_direction= true 时返回。 - - 1：未定义， - 0：正向， - 1：逆时针90度， - 2：逆时针180度， - 3：逆时针270度
image_status	是	string	normal-识别正常 reversed_side-身份证正反面颠倒 non_idcard-上传的图片中不包含身份证 blurred-身份证模糊 other_type_card-其他类型证照 over_exposure-身份证关键字段反光或过曝 over_dark-身份证欠曝（亮度过低） unknown-未知状态
card_ps	否	string	输入参数 detect_ps = true 时，则返回该字段，判断身份证是否被PS，返回值： - 0：正常， - 1：PS， - -1：无效
risk_type	否	string	输入参数 detect_risk = true 时，则返回该字段识别身份证风险类型: normal-正常身份证； copy-复印件； temporary-临时身份证； screen-翻拍； unknown-其他未知情况
edit_tool	否	string	如果参数 detect_risk = true 时，则返回此字段。如果检测身份证被编辑过，该字段指定编辑软件名称，如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值无此参数
card_quality	否	object	输入参数 detect_quality = true 时，则返回该字段识别身份证质量类型
+ IsClear	是	string	质量类型，是否清晰
+ IsClear_propobility	是	string	“是否清晰”质量类型对应的概率，值在0-1之间，值越大表示图像质量越好。默认阈值（仅为推荐值，建议按照实际业务场景，基于图片返回的具体概率值，自定义设置判断阈值）：当 IsClear_propobility 超过0.5时，对应 IsClear 返回1，低于0.5，则返回0
+ IsComplete	是	string	质量类型，是否边框/四角完整
+ IsComplete_propobility	是	string	“是否边框/四角完整”质量类型对应的概率，值在0-1之间，值越大表示图像质量越好。默认阈值（仅为推荐值，建议按照实际业务场景，基于图片返回的具体概率值，自定义设置判断阈值）：当 IsClear_propobility 超过0.5时，对应 IsComplete 返回1，低于0.5，则返回0
+ IsNoCover	是	string	质量类型，是否头像、关键字段无遮挡/马赛克
+ IsNoCover_propobility	是	string	“是否头像、关键字段无遮挡/马赛克”质量类型对应的概率，值在0-1之间，值越大表示图像质量越好。默认阈值（仅为推荐值，建议按照实际业务场景，基于图片返回的具体概率值，自定义设置判断阈值）：当 IsNoCover_propobility 超过0.3时，对应IsNoCover 返回1，低于0.3，则返回0
photo	否	string	当请求参数 detect_photo = true时返回，头像切图的 base64 编码（无编码头，需自行处理）
photo_location	否	object	当请求参数 detect_photo = true时返回，头像的位置信息（坐标0点为左上角）
card_image	否	string	当请求参数 detect_card = true时返回，身份证裁剪切图的 base64 编码（无编码头，需自行处理）
card_location	否	object	当请求参数 detect_card = true时返回，身份证裁剪切图的位置信息（坐标0点为左上角）
idcard_number_type	是	int	用于校验身份证号码、性别、出生是否一致，输出结果及其对应关系如下： - 1：身份证正面所有字段全为空 0：身份证证号不合法，此情况下不返回身份证证号 1：身份证证号和性别、出生信息一致 2：身份证证号和性别、出生信息都不一致 3：身份证证号和出生信息不一致 4：身份证证号和性别信息不一致
+ location	是	array[]	位置数组（坐标0点为左上角）
++ left	是	uint32	表示定位位置的长方形左上顶点的水平坐标
++ top	是	uint32	表示定位位置的长方形左上顶点的垂直坐标
++ width	是	uint32	表示定位位置的长方形的宽度
++ height	是	uint32	表示定位位置的长方形的高度
+ words	否	string	识别结果字符串

返回示例（身份证头像面）

{
    "log_id": "1559208562721579319",
    "direction": 0,
    "image_status": "normal",
    "photo": "/9j/4AAQSkZJRgABA......",
    "photo_location": {
        "width": 1189,
        "top": 638,
        "left": 2248,
        "height": 1483
    },
    "card_image": "/9j/4AAQSkZJRgABA......",
    "card_location": {
        "top": 328,
        "left": 275,
        "width": 1329,
        "height": 571
    },
    "words_result": {
        "住址": {
            "location": {
                "left": 267,
                "top": 453,
                "width": 459,
                "height": 99
            },
            "words": "南京市江宁区弘景大道3889号"
        },
        "公民身份号码": {
            "location": {
                "left": 443,
                "top": 681,
                "width": 589,
                "height": 45
            },
            "words": "330881199904173914"
        },
        "出生": {
            "location": {
                "left": 270,
                "top": 355,
                "width": 357,
                "height": 45
            },
            "words": "19990417"
        },
        "姓名": {
            "location": {
                "left": 267,
                "top": 176,
                "width": 152,
                "height": 50
            },
            "words": "伍云龙"
        },
        "性别": {
            "location": {
                "left": 269,
                "top": 262,
                "width": 33,
                "height": 52
            },
            "words": "男"
        },
        "民族": {
            "location": {
                "left": 492,
                "top": 279,
                "width": 30,
                "height": 37
            },
            "words": "汉"
        }
    },
    "words_result_num": 6
}

返回示例（身份证国徽面）

{
    "words_result": {
        "失效日期": {
            "words": "20390711",
            "location": {
                "top": 445,
                "left": 523,
                "width": 153,
                "height": 38
            }
        },
        "签发机关": {
            "words": "陆丰市公安局",
            "location": {
                "top": 377,
                "left": 339,
                "width": 195,
                "height": 38
            }
        },
        "签发日期": {
            "words": "20190606",
            "location": {
                "top": 445,
                "left": 343,
                "width": 152,
                "height": 38
            }
        }
    },
    "log_id": "1559208562721579328",
    "words_result_num": 3,
    "error_code": 0,
    "image_status": "normal"
}

AES加密

您可以选择使用AES加密来请求本身份证识别接口，支持对身份证图片及识别结果进行加密后传输，示意图如下：

在百度云控制台「文字识别-应用列表-管理」中获取您的AES Key
使用AES Key对将要识别的图片进行加密
将加密后的图片传入接口，请求参数AESEncry设置为true
接口返回加密后的识别结果，使用AES Key进行解密，得到明文识别结果

使用AES加密不影响身份证识别接口支持的质量检测、风险检测等其他能力，也不影响识别效果。