API Path
/aipaas/ocr/v1/identify/idcardRefactor
请求协议
HTTPS
请求方法
POST
请求头部 :
| 头部标签 | 必填 | 说明 | 类型 | 数据字典 | 限制 | 头部内容 | 示例 |
|---|---|---|---|---|---|---|---|
| Content-Type | 是 | application/json | [string] | application/json | application/json | ||
| X-APP-ID | 是 | 买家中心-已购能力-【X-APP-ID】 | [string] | ||||
| Device-Uuid | 否 | 设备管理-设备uuid | [string] | ||||
| Authorization | 是 | 鉴权信息 | [string] |
请求参数 Json
Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| uid | 身份识别码。能力接入方对接口调用方的身份认证,分配给数据EOP平台的身份识别码. | 否 | [string] | |||
| seqid | 请求序列号,usid,请求的唯一标识 | 是 | [string] | |||
| image | 待分析图像的base64编码,图像中文本倾斜较小,图像清晰度较高,数据建议不大于2M,超过2M不会调用失败,但是测试2M以上,尤其是4M以上响应较慢。 | 是 | [string] |
响应内容 :
返回结果
成功 (200)
Json
Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| seqid | 请求序列号,usid,请求的唯一标识 | 是 | [string] | |||
| code | 状态响应码。参考错误编码规范 | 是 | [string] | |||
| message | 调用结果描述。参考错误编码规范 | 是 | [string] | |||
| flag | 业务上成功或失败:1成功,0失败 | 是 | [int] | |||
| data | 是 | [object] | ||||
| data>>timeSecond | 分析用时(秒) | 是 | [int] | |||
| data>>words_result | 定位和识别结果数组 | 是 | [array] | |||
| data>>boxes | 坐标(左上角起始,顺时针排列) | 是 | [array] | |||
| data>>score | 置信度 | 是 | [float] | |||
| data>>score_label | 置信度水平1-5 | 是 | [int] | |||
| data>>words_result_num | 识别结果数,表示words_result的元素个数 | 是 | [number] | |||
| data>>pic_mark | “P10001”为不正常,"P10000"为正常。 | 是 | [string] |
详细说明 :
对二代居民身份证正反面所有8个字段进行结构化识别,包括姓名、性别、民族、出生日期、住址、身份证号、签发机关、有效期限。适用范围:身份证倾斜角度较小、较为清晰的情况下。
| 日期 | 版本 | 修订内容 |
|---|---|---|
| 2025-10-21 | V1.0.0 | 初始化API文档 |
服务接口调用时需要严格遵循服务鉴权规则,服务调用鉴权规则请参见:开发指南 - 签名认证方式。
| 返回编码 | 返回信息 | 说明 |
|---|---|---|
| 10000 | 成功 | |
| 10301 | 服务必填参数缺失 | 服务必填参数缺失或未填写 |
| 10304 | 请求参数格式错误 | 服务入参格式错误,输入图片格式需为base64位编码的数据 |
| 10305 | 请求参数范围错误 | 上传的图片大小错误,现阶段我们支持的图片大小为:base64编码后建议不大于2M,超过2M不会调用失败,但是测试2M以上,尤其是4M以上响应较慢。 |
| 10308 | 证件拍摄不完整,建议重拍 | 图片质量有问题建议重拍,正常图片报这个错需排除启动服务不成功。 |
| 10503 | 服务连接超时 | 连接第三方服务发生超时,返回服务连接超时错误 |
| 10903 | 服务执行失败 | 服务执行失败 |
通用状态码请参考【状态码】中的【网关认证】
注意:图片Base64编码过长,示例中仅展示部分内容。实际调用时,请确保编码完整以避免数据截断。6.调用示例中同理。
{
"uid": "test",
"seqid": "26f2739a-6e0f-11e8-bc7a-58fb8443ee27",
"image": " /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKB/4Q+z+COm+LLTxnZzXIvRqEutX9lLa"
}
import cn.hutool.http.HttpRequest;
import cn.hutool.http.HttpResponse;
import cn.hutool.json.JSONUtil;
import java.util.HashMap;
import java.util.Map;
/** 主类,用于发起HTTP请求并处理响应 */
public class Example {
public static void main(String[] args) {
example();
}
/**
* 方法中使用到的 JSONUtil、HttpRequest、HttpResponse均来自Hutool工具类。
* 具体maven依赖为:
*
* cn.hutool
* hutool-all
* 5.8.29
*
*/
public static void example() {
try {
String url = "算法调用地址";
// 设置请求头
Map headers = new HashMap();
//调用鉴权
headers.put("Content-Type", "application/json");
headers.put("X-APP-ID", "yourAppId");
headers.put("Authorization", "yourAuthorization");
// 创建请求对象
Map request = new HashMap();
request.put("seqid", "26f2739a-6e0f-11e8-bc7a-58fb8443ee27");
request.put("image", " /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKB/4Q+z+COm+LLTxnZzXIvRqEutX9lLa");
// 将请求对象转换为JsonNode
String requestString = JSONUtil.toJsonStr(request);
// 发起HTTP请求
HttpResponse response =
HttpRequest.post(url)
.headerMap(headers, true)
.body(requestString)
.execute();
// 输出响应结果
System.out.println(response.body());
} catch (Exception e) {
e.printStackTrace();
}
}
}
import json
import hashlib
import hmac
import time
import re
import urllib.parse
import requests
import warnings
from datetime import datetime
import logging
# 配置日志,设置日志级别为INFO,并指定日志格式
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
# 配置环境变量
X_APP_ID = "yourAppId"
AUTHORIZATION = "yourAuthorization"
# URL 和请求数据
url = "算法调用地址" # 请求的URL
request_data = {
"seqid": "26f2739a-6e0f-11e8-bc7a-58fb8443ee27",
"image": " /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAwUKB/4Q+z+COm+LLTxnZzXIvRqEutX9lLa"
}
# 构建请求头
headers = {
"Content-Type": "application/json",
"X-APP-ID": X_APP_ID,
"Authorization": AUTHORIZATION
}
def timeSimple(timestamp):
# 将时间戳转换为HH:MM:SS格式的时间字符串
dt_object = datetime.fromtimestamp(timestamp)
formatted_time = dt_object.strftime("%H:%M:%S")
return formatted_time
def send_request(url):
try:
start_time = time.time()
logging.info(f"请求路径: {url}")
logging.info(f"开始发送: {timeSimple(start_time)}")
with requests.post(
url, json=request_data, headers=headers, stream=True, verify=False
) as response:
first_packet_time = None
if response.status_code == 200:
logging.info(f"接受到返回: {timeSimple(time.time())}")
for chunk in response.iter_content(chunk_size=1024):
if chunk:
if first_packet_time is None:
first_packet_time = time.time()
logging.info(
f"Received chunk: {timeSimple(time.time())} {chunk.decode('utf-8')}"
)
end_time = time.time()
logging.info(f"Time to first byte (TTFB): {first_packet_time - start_time:.3f} seconds")
logging.info(f"Request completed in {end_time - start_time:.3f} seconds")
else:
logging.error(f"Request failed with status code {response.status_code}")
except Exception as e:
logging.error(f"An error occurred: {e}")
# 发送请求
send_request(url)
logging.info(f"headers = {headers}")