调用价格
5 匠币/次
快速接入
保持统一返回结构,直接通过服务端发起请求即可接入。
https://openapi.toolkk.com/v1/idcard-validatecURL 示例
curl --request POST \
--url 'https://openapi.toolkk.com/v1/idcard-validate' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "name": "张三",\n "idCardNo": "110105199003078887"\n}'Python 示例
import os
import requests
url = "https://openapi.toolkk.com/v1/idcard-validate"
payload = {
"name": "张三",
"idCardNo": "110105199003078887"
}
headers = {
"Content-Type": "application/json",
"X-API-Key": os.getenv("TOOLKK_API_KEY", "YOUR_API_KEY"),
}
response = requests.request("POST", url, headers=headers, json=payload, timeout=30)
response.raise_for_status()
print(response.json())Go 示例
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
endpoint := "https://openapi.toolkk.com/v1/idcard-validate"
payload := []byte("{\n \"name\": \"张三\",\n \"idCardNo\": \"110105199003078887\"\n}")
req, err := http.NewRequest("POST", endpoint, bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println(string(body))
}Java 示例
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ToolkkExample {
public static void main(String[] args) throws Exception {
String payload = "{\n \"name\": \"张三\",\n \"idCardNo\": \"110105199003078887\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/idcard-validate"))
.method("POST", HttpRequest.BodyPublishers.ofString(payload))
.header("Content-Type", "application/json")
.header("X-API-Key", "YOUR_API_KEY")
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}PHP 示例
<?php
$endpoint = 'https://openapi.toolkk.com/v1/idcard-validate';
$payload = "{\n \"name\": \"张三\",\n \"idCardNo\": \"110105199003078887\"\n}";
$ch = curl_init($endpoint);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-API-Key: YOUR_API_KEY',
],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response;响应示例
{
"code": "SUCCESS",
"message": "success",
"data": {
"result": "一致",
"desc": "姓名和身份证号一致",
"sex": "男",
"birthday": "19900307",
"address": "北京市西城区"
}
}示例用于理解返回结构,实际结果以接口返回为准。
- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 600 次/分钟
- 超时时间
- 5000 ms
服务端调用时,将 API Key 放在 X-API-Key 请求头中。
建议按 response code 与业务字段双重判断调用结果。
高频调用场景请结合速率限制与重试策略使用。
请求字段
从服务端发起请求,并在 X-API-Key 请求头中传入密钥。
请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| name | string | 未标注 | 未标注 | 张三 |
| idCardNo | string | 未标注 | 未标注 | 110105199003078887 |
请求示例
{
"name": "张三",
"idCardNo": "110105199003078887"
}- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 600 次/分钟
- 超时时间
- 5000 ms
响应字段
示例用于理解返回结构,实际结果以接口返回为准。
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| code | string | 未标注 | 未标注 | SUCCESS |
| message | string | 未标注 | 未标注 | success |
| data | object | 未标注 | 未标注 | {...} |
| data.result | string | 未标注 | 未标注 | 一致 |
| data.desc | string | 未标注 | 未标注 | 姓名和身份证号一致 |
| data.sex | string | 未标注 | 未标注 | 男 |
| data.birthday | string | 未标注 | 未标注 | 19900307 |
| data.address | string | 未标注 | 未标注 | 北京市西城区 |
响应示例
{
"code": "SUCCESS",
"message": "success",
"data": {
"result": "一致",
"desc": "姓名和身份证号一致",
"sex": "男",
"birthday": "19900307",
"address": "北京市西城区"
}
}$.code == 200接口简介
接口能力、应用场景、使用限制与常见问题。
接口能力
提交姓名与身份证号,核对这两项信息是否一致,返回核验结论、结果说明及本次提供的性别、生日和地址等辅助资料。它适合检查业务收到的身份文本组合,不需要提交证件照片。接口取得的是数据一致性结果,不确认当前操作者就是证件本人,也不进行人脸活体检测或手机控制权验证。
应用场景
注册或资料更新流程可在用户提交身份信息后进行二要素比对,把一致、不一致与无法取得结论分别处理;人工审核可将返回说明与用户本次输入一起核对,减少姓名录入错误;身份资料页面可按实际需要展示有限辅助信息。即使核验一致,也不能据此证明证件照片真伪、证件仍在有效期或操作者具有相关业务资格。
使用与结果解读
使用同一人的姓名和身份证号,保留证件号码字符串及姓名原文,先排除空白和明显录入错误。接收结果后先确认调用状态,再查看业务核验结果与说明;一致可供下一步骤参考,不一致先核查输入,服务异常或未取得结论进入复核。辅助资料缺失时不要从号码自行补成接口返回值,也不要把生日、性别或地址的有无代替二要素结论。
范围与限制
当前没有公开全量身份覆盖、固定更新频率、特殊姓名处理和准确率承诺,未核验成功不等于证件伪造或用户欺诈。核验结果与调用状态属于不同信息,不能仅因请求成功就自动放行。接口没有确认地址是当前居住地、联系方式或可用于寄送的地址。业务应按实际目的使用辅助资料,在日志和页面中避免不必要地展示完整证件号码及个人信息。
常见问题
一致能证明操作人是本人吗?
不能。它仅核对姓名和证件号的数据组合,没有验证当前操作者的身份或活体。
需要上传身份证照片吗?
本端点使用姓名与身份证号文本,没有已确认的照片识别或证件图像核验能力。
调用成功等于信息一致吗?
不是。应独立读取核验结果及说明,服务异常、不一致和无法取得结论要分别处理。
返回地址是当前居住地址吗?
没有这样的保证。它是本次附带的身份资料,不应当作实时住址或寄送地址。