接口地址:https://aip.baidubce.com/rest/2.0/ocr/v1/idcard |
---|
返回格式:json |
请求方式:post |
请求示例:https://aip.baidubce.com/rest/2.0/ocr/v1/idcard?access_token=test |
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
image | string | 必填 | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式 |
id_card_side | string | 必填 | front:身份证含照片的一面;back:身份证带国徽的一面 |
detect_direction | string | 选填 | 是否检测图像旋转角度,默认检测,即:true。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括: - true:检测旋转角度并矫正识别; - false:不检测旋转角度,针对摆放情况不可控制的情况建议本参数置为true。 |
detect_risk | string | 选填 | 是否开启身份证风险类型(身份证复印件、临时身份证、身份证翻拍、修改过的身份证)功能,默认不开启,即:false。可选值:true-开启;false-不开启 |
名称 | 类型 | 说明 |
---|---|---|
direction | int32 | 图像方向,当detect_direction=true时存在。<br>- -1:未定义,<br>- 0:正向,<br>- 1: 逆时针90度,<br>- 2:逆时针180度,<br>- 3:逆时针270度 |
image_status | string | normal-识别正常<br>reversed_side-身份证正反面颠倒<br>non_idcard-上传的图片中不包含身份证<br>blurred-身份证模糊<br>other_type_card-其他类型证照<br>over_exposure-身份证关键字段反光或过曝<br>over_dark-身份证欠曝(亮度过低)<br>unknown-未知状态 |
risk_type | string | 输入参数 detect_risk = true 时,则返回该字段识别身份证类型: normal-正常身份证;copy-复印件;temporary-临时身份证;screen-翻拍;unknown-其他未知情况 |
edit_tool | string | 如果参数 detect_risk = true 时,则返回此字段。如果检测身份证被编辑过,该字段指定编辑软件名称,如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值无此参数 |
log_id | uint64 | 唯一的log id,用于问题定位 |
words_result | array() | 定位和识别结果数组 |
words_result_num | uint32 | 识别结果数,表示words_result的元素个数 |
+location | array() | 位置数组(坐标0点为左上角) |
++left | uint32 | 表示定位位置的长方形左上顶点的水平坐标 |
++top | uint32 | 表示定位位置的长方形左上顶点的垂直坐标 |
++width | uint32 | 表示定位位置的长方形的宽度 |
++height | uint32 | 表示定位位置的长方形的高度 |
+words | string | 识别结果字符串 |
{
"log_id": 2648325511,
"direction": 0,
"image_status": "normal",
"idcard_type": "normal",
"edit_tool": "Adobe Photoshop CS3 Windows",
"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
}
错误码 | 说明 |
---|---|
1 | 服务器内部错误,请再次请求, 如果持续出现此类错误,请在控制台提交工单联系技术支持团队 |
2 | 服务暂不可用,请再次请求, 如果持续出现此类错误,请在控制台提交工单联系技术支持团队 |
3 | 调用的API不存在,请检查后重新尝试 |
4 | 集群超限额 |
6 | 无权限访问该用户数据 |
14 | IAM鉴权失败,建议用户参照文档自查生成sign的方式是否正确,或换用控制台中ak sk的方式调用 |
17 | 每天请求量超限额 |
18 | QPS超限额 |
19 | 请求总量超限额 |
100 | 无效的access_token参数,请检查后重新尝试 |
110 | access_token无效 |
111 | access token过期 |
282000 | 服务器内部错误,如果您使用的是高精度接口,报这个错误码的原因可能是您上传的图片中文字过多,识别超时导致的,建议您对图片进行切割后再识别,其他情况请再次请求, 如果持续出现此类错误,请在控制台提交工单联系技术支持团队 |
216100 | 请求中包含非法参数,请检查后重新尝试 |
216101 | 缺少必须的参数,请检查参数是否有遗漏 |
216102 | 请求了不支持的服务,请检查调用的url |
216103 | 请求中某些参数过长,请检查后重新尝试 |
216110 | appid不存在,请重新核对信息是否为后台应用列表中的appid |
216200 | 图片为空,请检查后重新尝试 |
216201 | 上传的图片格式错误,现阶段我们支持的图片格式为:PNG、JPG、JPEG、BMP,请进行转码或更换图片 |
216202 | 上传的图片大小错误,现阶段我们支持的图片大小为:base64编码后小于4M,分辨率不高于4096*4096,请重新上传图片 |
216630 | 识别错误,请再次请求,如果持续出现此类错误,请在控制台提交工单联系技术支持团队 |
216631 | 识别银行卡错误,出现此问题的原因一般为:您上传的图片非银行卡正面,上传了异形卡的图片或上传的银行卡正品图片不完整 |
216633 | 识别身份证错误,出现此问题的原因一般为:您上传了非身份证图片或您上传的身份证图片不完整 |
216634 | 检测错误,请再次请求,如果持续出现此类错误,请在控制台提交工单联系技术支持团队 |
272000 | 未能匹配模板,请检查参照字段的设置是否符合规范,并重新选取或增加更多的参照字段 |
272001 | 未能成功分类 |
282003 | 请求参数缺失 |
282004 | 您指定的模板暂未发布,请先保存发布该模板,再调用 |
282005 | 处理批量任务时发生部分或全部错误,请根据具体错误码排查 |
282006 | 批量任务处理数量超出限制,请将任务数量减少到10或10以下 |
282102 | 未检测到图片中识别目标,请确保图片中包含对应卡证票据 |
282103 | 图片目标识别错误,请确保图片中包含对应卡证票据,如果持续出现此类错误,请在控制台提交工单联系技术支持团队 |
282110 | URL参数不存在,请核对URL后再次提交 |
282111 | URL格式非法,请检查url格式是否符合相应接口的入参要求 |
282112 | url下载超时,请检查url对应的图床/图片无法下载或链路状况不好,您可以重新尝试一下,如果多次尝试后仍不行,建议更换图片地址 |
282113 | URL返回无效参数 |
282114 | URL长度超过1024字节或为0 |
282808 | request id xxxxx 不存在 |
282809 | 返回结果请求错误(不属于excel或json) |
282810 | 图像识别错误 |
身份证识别
curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/idcard?access_token=###########' --data 'id_card_side=front&image=【图片Base64编码,需UrlEncode】' -H 'Content-Type:application/x-www-form-urlencoded'
<?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(
"image" => $img
);
$res = request_post($url, $bodys);
var_dump($res);
/*
* Copyright (C) 2017 Baidu, Inc. All Rights Reserved.
*/
package com.baidu.ai.aip.ocr;
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 void main(String[] args) {
// 身份证识别url
String idcardIdentificate = "https://aip.baidubce.com/rest/2.0/ocr/v1/idcard";
// 本地图片路径
String filePath = "#####本地文件路径#####";
try {
byte[] imgData = FileUtil.readFileByBytes(filePath);
String imgStr = Base64Util.encode(imgData);
// 识别身份证正面id_card_side=front;识别身份证背面id_card_side=back;
String params = "id_card_side=front&" + URLEncoder.encode("image", "UTF-8") + "="
+ URLEncoder.encode(imgStr, "UTF-8");
/**
* 线上环境access_token有过期时间, 客户端可自行缓存,过期后重新获取。
*/
String accessToken = "#####调用鉴权接口获取的token#####";
String result = HttpUtil.post(idcardIdentificate, accessToken, params);
System.out.println(result);
} catch (Exception e) {
e.printStackTrace();
}
}
}
# coding:utf-8
import base64
import urllib, urllib2, sys
access_token = '#####调用鉴权接口获取的token#####'
url = 'https://aip.baidubce.com/rest/2.0/ocr/v1/idcard?access_token=' + access_token
# 二进制方式打开图文件
f = open(r'########本地文件#######', 'rb')
# 参数image:图像base64编码
img = base64.b64encode(f.read())
params = {"image": img, "id_card_side": "front"}
params = urllib.urlencode(params)
request = urllib2.Request(url, params)
request.add_header('Content-Type', 'application/x-www-form-urlencoded')
response = urllib2.urlopen(request)
content = response.read()
if (content):
print(content)
#include <iostream>
#include <curl/curl.h>
#include <boost/property_tree/ptree.hpp>
#include <boost/property_tree/json_parser.hpp>
#include <boost/date_time.hpp>
#include "idcard.h"
// libcurl库下载链接:https://curl.haxx.se/download.html
// jsoncpp库下载链接:https://github.com/open-source-parsers/jsoncpp/
// 身份证识别接口url
const static std::string idcard_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;
}
/**
* 调用身份证ocr接口,返回json格式的结果,具体格式解析见百度大脑文档
* @param json_result 以string格式返回的json格式的结果
* @param image_base64 以string格式传递的base64编码的图像数据(注:base64数据不包含格式信息(即不包含data:image/jpeg;base64))
* @param access_token 以string格式传入的access token数据,access token获取方式见access_token获取相关文档及代码
* @param id_card_side 卡的正面或背面
* @return 调用成功返回0,发生错误返回其他错误码
*/
int idcard_recognize(std::string &json_result, const std::string &image_base64,const std::string &access_token, const std::string id_card_side){
std::string url = idcard_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, "image", CURLFORM_COPYCONTENTS, image_base64.data(),
CURLFORM_END);
curl_formadd(&post, &last, CURLFORM_COPYNAME, "id_card_side", CURLFORM_COPYCONTENTS, id_card_side.data(),
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
",
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;
}
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 strbaser64 = FileUtils.getFileBase64("/work/ai/images/ocr/idcard.jpeg"); // 图片的base64编码
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.ContentType = "application/x-www-form-urlencoded";
request.KeepAlive = true;
String str = "id_card_side=front&image=" + HttpUtility.UrlEncode(strbaser64);
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;
}
}
}