/identity/handhold_idcard_verification
优质
小牛编辑
132浏览
2023-12-01
1.接口描述
该 API 的功能是将手持身份证照中的被拍人的脸和手持身份证上的人脸进行比对,判断是否为同一人。
图片要求
- 格式为 JPG(JPEG),BMP,PNG,GIF,TIFF
- 宽和高大于 8px,小于等于4000px
- 小于等于 5 MB
上传图片规范
- 头像与身份证无重叠
- 本人头像清晰
- 身份证信息清晰
- 无第三张人脸
支持自动识别人脸方向
- 上传的图片中包含有 exif 方向信息,先按此信息旋转、翻转后再做识别人脸方向并调整
- 如果照片方向混乱且 exif 方向信息不存在或不正确,自动识别人脸方向并调整
请求方式
POST
请求 URL
https://cloudapi.linkface.cn/identity/handhold_idcard_verification
2.请求参数
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
api_id | string | 是 | API 账户 |
api_secret | string | 是 | API 密钥 |
file | file | 见下方注释 | 手持身份证照文件 |
file_url | string | 见下方注释 | 手持身份证照文件的url。采用抓取网络文件方式时选取此参数 |
file_id | string | 见下方注释 | 手持身份证照文件的id。在云端上传过文件可选取此参数 |
auto_rotate | boolean | 可选 | 是否对照片进行自动翻转,默认不翻转 |
请求参数
file
,file_url
与file_id
三选一。
3.返回参数
字段 | 类型 | 描述 |
---|---|---|
request_id | string | 本次请求的id |
status | string | 返回状态,正常为 OK ,其他值表示失败。详见错误码 |
verify_score | float | 置信度。取值范围为 0~1,值越大表示两张人脸是同一个人的可能性越大 |
image_id | string | 手持证件照文件的id。如果使用file、url方式上传活体数据返回此参数 |
手持证件照中需要保证有且仅有两张人脸。
置信度阈值与错误率对应关系:
阈值 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 |
---|---|---|---|---|---|---|
错误率 | 十分之一 | 百分之一 | 千分之一 | 万分之一 | 十万分之一 | 百万分之一 |
{
"request_id": "TID3923f103e1ca49b7b434bdddefb680d8",
"status": "OK",
"verify_score": 0.7027237415313721,
"image_id": "b379f72402624858b895a955ec31ed8f"
}
4.错误码
状态码 | status 字段 | 说明 |
---|---|---|
400 | FACE_DETECTION_FAILED | 检测人脸失败,错误原因详见reason字段 |
400 | ENCODING_ERROR | 参数非UTF-8编码 |
400 | DOWNLOAD_TIMEOUT | 网络地址获取超时,详情见字段 image |
400 | DOWNLOAD_ERROR | 网络地址获取失败,详情见字段 image |
400 | IMAGE_FILE_SIZE_TOO_BIG | 图片体积过大。对应图片见字段 image 所反馈的值 |
400 | IMAGE_ID_NOT_EXIST | 图片不存在。对应图片见字段 image 所反馈的值。 |
400 | CORRUPT_IMAGE | 不是图片文件或已经损坏。对应图片见字段 image 所反馈的值 |
400 | INVALID_IMAGE_FORMAT_OR_SIZE | 图片大小或格式不符合要求。对应图片见字段 image 所反馈的值 |
400 | INVALID_ARGUMENT | 请求参数错误,具体原因见 reason 字段内容 |
401 | UNAUTHORIZED | 账号或密钥错误 |
401 | KEY_EXPIRED | 账号过期,具体情况见 reason 字段内容 |
403 | RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
403 | NO_PERMISSION | 无调用权限 |
403 | OUT_OF_QUOTA | 调用次数超出限额 |
404 | NOT_FOUND | 请求路径错误 |
500 | INTERNAL_ERROR | 服务器内部错误 |
备注\: 当status为FACE_DETECTION_FAILED
,reason
字段可能有以下返回:
no face detected
:没有检测到人脸no two faces detected
:只检测到一张人脸too many faces
: 检测到多与两张人脸
5.输入示例
cURL 样例
curl -X POST "https://cloudapi.linkface.cn/identity/handhold_idcard_verification?api_id=ID&api_secret=SECRET" \
-F file=@/PATH/TO/IMAGE
HTTPie 样例
http -f POST "https://cloudapi.linkface.cn/identity/handhold_idcard_verification?api_id=ID&api_secret=SECRET" \
file@/PATH/TO/IMAGE
C++ 样例
#include <iostream>
#include <cstring>
#include <exception>
#include <curl/curl.h>
#include <json/json.h>
using namespace std;
size_t callback(char *ptr, size_t size, size_t nmemb, string &stream){
size_t sizes = size*nmemb;
string temp(ptr,sizes);
stream += temp;
return sizes;
}
int main( int argv, char * argc[] ){
CURL *curl;
CURLM *multi_handle;
CURLcode res;
long code;
string stream;
struct curl_httppost *formpost = NULL;
struct curl_httppost *lastptr = NULL;
struct curl_slist *headerlist = NULL;
try{
curl_global_init(CURL_GLOBAL_DEFAULT);
curl = curl_easy_init();
if( curl ){
curl_formadd(&formpost,&lastptr,CURLFORM_COPYNAME,"api_id",
CURLFORM_COPYCONTENTS, "ID",CURLFORM_END);
curl_formadd(&formpost,&lastptr,CURLFORM_COPYNAME,"api_secret",
CURLFORM_COPYCONTENTS, "SECRET",CURLFORM_END);
curl_formadd(&formpost,&lastptr,CURLFORM_COPYNAME,"file",
CURLFORM_FILE, argc[1], CURLFORM_END);
curl_easy_setopt(curl, CURLOPT_URL, "https://cloudapi.linkface.cn/identity/handhold_idcard_verification");
curl_easy_setopt(curl, CURLOPT_HTTPPOST, formpost);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, callback);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &stream);
#ifdef SKIP_PEER_VERIFICATION
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
#endif
#ifdef SKIP_HOSTNAME_VERIFICATION
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
#endif
res = curl_easy_perform(curl);
if( res != CURLE_OK ){
cout<<"curl_easy_perform() failed:"<<curl_easy_strerror(res)<<endl;
return -1;
}
curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &code);
Json::Value res_data;
Json::Reader *reader = new Json::Reader(Json::Features::strictMode());
if(!reader->parse(stream, res_data)){
cout<<"parse error";
return -1;
}
cout<<"HTTP Status Code:"<<code<<endl;
cout<<res_data<<endl;
curl_easy_cleanup(curl);
}
curl_global_cleanup();
}catch(exception &ex){
cout<<"curl exception:"<<ex.what()<<endl;
}
}
Java 样例
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.MultipartEntity;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.util.EntityUtils;
public class httpClientPost {
public static final String api_id = "ID";
public static final String api_secret = "SECRET";
public static final String filepath = "C:/Users/face.jpg";//图片路径
public static final String POST_URL = "https://cloudapi.linkface.cn/identity/handhold_idcard_verification";
public static void HttpClientPost() throws ClientProtocolException, IOException {
HttpClient httpclient = new DefaultHttpClient();
HttpPost post = new HttpPost(POST_URL);
StringBody id = new StringBody(api_id);
StringBody secret = new StringBody(api_secret);
FileBody fileBody = new FileBody(new File(filepath));
MultipartEntity entity = new MultipartEntity();
entity.addPart("api_id", id);
entity.addPart("api_secret", secret);
entity.addPart("file", fileBody);
post.setEntity(entity);
HttpResponse response = httpclient.execute(post);
if (response.getStatusLine().getStatusCode() == 200) {
HttpEntity entitys = response.getEntity();
BufferedReader reader = new BufferedReader(
new InputStreamReader(entitys.getContent()));
String line = reader.readLine();
System.out.println(line);
}else{
HttpEntity r_entity = response.getEntity();
String responseString = EntityUtils.toString(r_entity);
System.out.println("错误码是:"+response.getStatusLine().getStatusCode()+" "+response.getStatusLine().getReasonPhrase());
System.out.println("出错原因是:"+responseString);
//你需要根据出错的原因判断错误信息,并修改
}
httpclient.getConnectionManager().shutdown();
}
public static void main(String[] args) throws ClientProtocolException, IOException {
HttpClientPost();
}
}
Ruby 样例
require 'net/http/post/multipart'
require 'json'
begin
uri = URI.parse('https://cloudapi.linkface.cn/identity/handhold_idcard_verification')
File.open("px.jpg") do |jpg|
req = Net::HTTP::Post::Multipart.new uri.path,
"file" => UploadIO.new(jpg, "image/jpeg", "px.jpg"),
"api_id" => "ID",
"api_secret" => "SECRET"
res = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(req)
end
result = JSON.parse(res.body)
puts result
end
rescue Exception => e
puts e.message
end
Python 样例
我们提供的样例支持 Python 2.7 & 3.4–3.7 和 PyPy,其他版本暂不提供,需要您查阅相关资料。
import requests
try:
host = 'https://cloudapi.linkface.cn'
url = host + '/identity/handhold_idcard_verification'
files = {'file': open('/file/path', 'rb')}
data = {'api_id': 'ID','api_secret': 'SECRET'}
response = requests.post(url, files = files, data = data)
result = response.json()
print result
except Exception as e:
print("type error: " + str(e))
PHP 样例
我们提供的样例是基于 PHP 5.5 与 PHP 5.6 两个版本,其他版本暂不提供,需要您查阅相关资料。
以下样例是基于 PHP 5.5 版本的。
<?php
$testurl = 'https://cloudapi.linkface.cn/identity/liveness_idnumber_verification';
$filePath = 'C:/Users/face.jpg'; //图片路径
$fileContent = '@' . realpath($filePath);
$post_data = array ('api_id' => 'ID','api_secret' => 'SECRET','file' => $fileContent);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $testurl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);//您可以根据需要,决定是否打开SSL验证
curl_setopt($ch, CURLOPT_POST,1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
$output = curl_exec($ch);
var_dump($output);
curl_close($ch);
?>
以下样例是基于 PHP 5.6 版本的。
<?php
$testurl = 'https://cloudapi.linkface.cn/identity/handhold_idcard_verification';
$filePath = 'C:/Users/face.jpg'; //图片路径
$fileContent = new \CURLFile($filePath);
$post_data = array ('api_id' => 'ID','api_secret' => 'SECRET','file' => $fileContent);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $testurl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);//您可以根据需要,决定是否打开SSL验证
curl_setopt($ch, CURLOPT_POST,1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
$output = curl_exec($ch);
var_dump($output);
curl_close($ch);
?>