身份证实名认证
传入姓名、身份证号,校验此两项是否匹配,同时解析,生日、性别、年龄、省份等信息。
个人用户无法使用该接口,需完成企业认证
官网购买的套餐通过API调用时请使用“扣套餐次数”密钥进行调用
请求地址
GEThttps://api.shuxuntech.com/v1/idCard/check
¥0.04元 / 次
阶梯计价,用量越大单价越低
企业认证后额外赠送 666 次调用额度
01 — 接口说明
请求参数与返回结果
所有请求需在 header 中携带签名信息,body 参数按 x-www-form-urlencoded 提交
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| appKey | head | string | 是 | 数勋分配appKey |
| timestamp | head | string | 是 | 当前时间的毫秒数 |
| sign | head | string | 是 | 签名,说明 |
| name | query | string | 是 | 姓名 |
| idCard | query | string | 是 | 身份证号码 |
签名算法说明
数勋分配的appKey、当前unix时间毫秒数timestamp、数勋分配的appSecret、 按顺序拼接sha256加密得到sign,查看如下示例
appKey = aaa;timestamp = 1682476904289;appSecret = bbb;sign = sha256(appKey+timestamp+appSecret)02 — 返回说明
返回结构与字段含义
顶层返回 code 与 msg,业务数据在 data 对象内,各字段含义见下方表格
返回字段描述
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | string | 错误码 |
| msg | string | 错误描述 |
| isFee | int | 是否计费(1:计费,0:不计费) |
| seqNo | string | 调用流水号 |
| data | object | 返回数据 |
data对象说明
| 字段名 | 类型 | 描述 |
|---|---|---|
| result | int | 核验结果(1:一致,2:不一致,3:无记录) |
| resultDesc | string | 核验结果描述 |
| birthday | string | 生日,yyyyMMdd |
| gender | int | 性别(1:男,0:女) |
| age | int | 年龄 |
| province | string | 省份 |
| city | string | 地市 |
| district | string | 区县 |
| area | string | 籍贯信息 |
code错误码说明
| code | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 参数错误 |
| 2 | 无记录 |
| 3 | 第三方服务异常 |
| 4 | 签名错误 |
| 5 | 余额不足 |
| 6 | 调用频率超限 |
| 7 | 账号停用 |
| 8 | 接口已停用 |
| 9 | 联系服务商开通接口权限 |
| 10 | ip不在白名单 |
| 11 | 系统异常 |
| 12 | 实名状态错误 |
| 99 | 其他异常,具体返回为准 |
返回示例
正确返回
{ "code": "0", "msg": "成功", "isFee": 1, "seqNo": "dm6upqegqalrrqmztuhlv5htosblm1o0", "data": { "birthday": "19911029", "gender": 1, "age": 32, "province": "浙江", "city": "杭州", "district": "上城区", "area": "浙江省杭州市上城区", "result": 2, "resultDesc": "核验不一致" }}错误返回
{ "code": "1", "msg": "请输入合法的名字", "isFee": 0, "seqNo": null, "data": null}03 — 代码示例
七种语言,复制即用
签名规则:sha256(appKey + timestamp + appSecret),下列示例已包含完整签名流程
IdCardCheckDemo.java
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.security.MessageDigest;
/**
* 身份证实名核验 - Java 示例代码
* 接口地址:https://api.shuxuntech.com/v1/idCard/check
*
* 说明:本示例只使用 JDK 原生 API(java.net / java.security),不依赖任何第三方 jar 包,
* 也不需要本项目的工具类,复制到本地即可编译运行:
* javac IdCardCheckDemo.java
* java IdCardCheckDemo
*/
public class IdCardCheckDemo {
/** 数勋分配的 appKey,请替换为您自己的 appKey */
private static final String APP_KEY = "您的appKey";
/** 数勋分配的 appSecret,请替换为您自己的 appSecret */
private static final String APP_SECRET = "您的appSecret";
/** 接口地址 */
private static final String API_URL = "https://api.shuxuntech.com/v1/idCard/check";
/** 姓名(示例值,请替换为实际核验的姓名) */
private static final String NAME = "张三";
/** 身份证号码(示例值,请替换为实际核验的身份证号) */
private static final String ID_CARD = "330102199001011234";
public static void main(String[] args) throws Exception {
// 1、当前 unix 时间毫秒值,服务端要求与服务器时间相差不能超过 5 分钟
String timestamp = String.valueOf(System.currentTimeMillis());
// 2、签名:按顺序拼接 appKey + timestamp + appSecret 后做 sha256,得到小写十六进制字符串
String sign = sha256Hex(APP_KEY + timestamp + APP_SECRET);
// 3、业务参数,放在 url 的 query 里
String query = "name=" + urlEncode(NAME) + "&idCard=" + urlEncode(ID_CARD);
// 4、发起 GET 请求,appKey、timestamp、sign 放在请求头
HttpURLConnection conn = (HttpURLConnection) new URL(API_URL + "?" + query).openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("appKey", APP_KEY);
conn.setRequestProperty("timestamp", timestamp);
conn.setRequestProperty("sign", sign);
conn.setConnectTimeout(10000);
conn.setReadTimeout(15000);
int status = conn.getResponseCode();
// 5、读取返回内容:正常读输入流,报错时读错误流,避免只拿到一个异常看不到原因
InputStream in = (status >= 200 && status < 300) ? conn.getInputStream() : conn.getErrorStream();
String result = readAll(in);
conn.disconnect();
System.out.println("HTTP状态码=" + status);
System.out.println("返回结果=" + result);
}
/**
* sha256 加密,返回小写十六进制字符串
* 服务端校验签名用的就是这个算法(小写十六进制)
*/
private static String sha256Hex(String content) throws Exception {
byte[] bytes = MessageDigest.getInstance("SHA-256").digest(content.getBytes("UTF-8"));
StringBuilder sb = new StringBuilder(bytes.length * 2);
for (byte b : bytes) {
sb.append(Character.forDigit((b >> 4) & 0xF, 16));
sb.append(Character.forDigit(b & 0xF, 16));
}
return sb.toString();
}
/** url 编码,姓名等中文参数需要编码 */
private static String urlEncode(String value) throws Exception {
return URLEncoder.encode(value, "UTF-8");
}
/** 读取输入流内容 */
private static String readAll(InputStream in) throws Exception {
if (in == null) {
return "";
}
StringBuilder sb = new StringBuilder();
BufferedReader reader = new BufferedReader(new InputStreamReader(in, "UTF-8"));
try {
String line;
while ((line = reader.readLine()) != null) {
sb.append(line);
}
} finally {
reader.close();
}
return sb.toString();
}
}04 — 在线调试
先调通,再决定
用你自己的数据发一次真实请求,表单字段随接口定义自动生成,返回结果附字段注释
GEThttps://api.shuxuntech.com/v1/idCard/check按次计费 · 优先扣套餐次数
请求参数
按接口定义自动生成
- name*姓名
- idCard*身份证号码
appKey / timestamp / sign调用时自动按 sha256 生成,无需手填
appKey=未获取 · timestamp=实时生成 · sign=自动生成
这是真实调用,会消耗套餐次数或账户余额; 请勿用真实证件信息反复试调
调不通时先看这里错误码与返回字段的完整说明见上方「02 — 返回说明」;签名口径与「03 — 代码示例」完全一致,可直接复制使用。
返回结果
点击左侧「提交并调用接口」,参数会就地组装、按文档口径签名后直接请求接口, 返回的 JSON 显示在这里。
在线调试使用你自己的 appKey,按实际调用计费。
返回结果是纯 JSON,字段含义见上方「02 — 返回说明」字段类型与取值说明以「02 — 返回说明」的字段表为准;错误码的完整定义同样在那一节。
05 — 产品价格
阶梯计价,用多少买多少
单次价格随调用量阶梯下降,大档位单价最低
| 调用量 | 价格 | 单价 |
|---|---|---|
| 20 次 | ¥ 0 | ¥ 0 |
| 500 次 | ¥ 35 | ¥ 0.07 |
| 5,000 次 | ¥ 320 | ¥ 0.064 |
| 10,000 次 | ¥ 600 | ¥ 0.06 |
| 50,000 次 | ¥ 2,800 | ¥ 0.056 |
| 100,000 次 | ¥ 5,000 | ¥ 0.05 |
| 500,000 次 | ¥ 23,000 | ¥ 0.046 |
| 1,000,000 次 | ¥ 40,000 | ¥ 0.04 |