调用价格
1 匠币/次
快速接入
保持统一返回结构,直接通过服务端发起请求即可接入。
https://openapi.toolkk.com/v1/idcard-area-querycURL 示例
curl --request POST \
--url 'https://openapi.toolkk.com/v1/idcard-area-query' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: YOUR_API_KEY' \
--data '{\n "idCardNo": "110105199003078887"\n}'Python 示例
import os
import requests
url = "https://openapi.toolkk.com/v1/idcard-area-query"
payload = {
"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-area-query"
payload := []byte("{\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 \"idCardNo\": \"110105199003078887\"\n}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://openapi.toolkk.com/v1/idcard-area-query"))
.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-area-query';
$payload = "{\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": "200",
"message": "success",
"data": {
"areaCode": "110105",
"areaName": "北京市朝阳区"
}
}示例用于理解返回结构,实际结果以接口返回为准。
- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 600 次/分钟
- 超时时间
- 5000 ms
服务端调用时,将 API Key 放在 X-API-Key 请求头中。
建议按 response code 与业务字段双重判断调用结果。
高频调用场景请结合速率限制与重试策略使用。
请求字段
从服务端发起请求,并在 X-API-Key 请求头中传入密钥。
请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| idCardNo | string | 未标注 | 未标注 | 110105199003078887 |
请求示例
{
"idCardNo": "110105199003078887"
}- 鉴权方式
- 请求头传入 X-API-Key
- 默认限流
- 600 次/分钟
- 超时时间
- 5000 ms
响应字段
示例用于理解返回结构,实际结果以接口返回为准。
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| code | string | 未标注 | 未标注 | 200 |
| message | string | 未标注 | 未标注 | success |
| data | object | 未标注 | 未标注 | {...} |
| data.areaCode | string | 未标注 | 未标注 | 110105 |
| data.areaName | string | 未标注 | 未标注 | 北京市朝阳区 |
响应示例
{
"code": "200",
"message": "success",
"data": {
"areaCode": "110105",
"areaName": "北京市朝阳区"
}
}$.code == 200 接口简介
接口能力、应用场景、使用限制与常见问题。
接口能力
根据身份证号码查询地址码对应的地区编号与地区名称,便于应用识别号码编码中的地区信息。当前返回的核心内容是地区代码和地区名称,例如 110105 对应北京市朝阳区。它提供地区查询结果,不输出三个独立的省、市、区字段,也不返回姓名、生日或性别等身份信息。
应用场景
适合资料录入时展示号码地区、对历史数据进行地区标签整理,以及帮助使用者理解身份证地址码。系统可保存完整地区名称用于展示,保留地区代码用于分类;若需要拆分为省市区,应另行使用可靠的行政区划资料,不能只凭名称字符位置截取。资料中的实际居住地址仍需要由本人提供或独立核实。
使用与结果解读
提交完整的身份证号码后,检查查询是否成功,再读取地区编号与名称。地区代码应作为字符串保留,避免数值转换影响编码格式。当前结果中的地区名称可用于提示地址码含义;如果查询失败、名称为空或代码无法匹配,应提示未获得对应地区,不应根据号码其他片段猜出地区或替用户补写详细地址。
范围与限制
身份证地址码与当前居住地、工作地或实时位置不是同一概念,也不证明证件真实有效或号码归某个人所有。行政区划和历史编码存在变化,地区名应按所返回的编码资料解读。需要核验身份或联系地址时,应使用相应的身份核验或地址资料,不能把地区查询结果扩展为实名认证结论。
常见问题
返回的地区是现在的居住地址吗?
不是。结果解释身份证号码的地址码,不能推断当前住址或实时位置。
110105 对应哪个地区?
北京市朝阳区;公开示例已修正此前地区代码与名称不一致的问题。
能同时查出姓名、生日和性别吗?
当前接口只提供地区编号和地区名称,不提供这些身份信息。
查到地区是否说明身份证真实有效?
不能。地区码查询与证件真实性、实名一致性核验是不同能力。