idcard-area-query
Chinese ID Card Location Lookup
Look up the location of an ID card number, including province and city. Supports fast verification and lookup of mainland China ID card numbers.
Usage Cost
1 coins/call
Quick Start
Use a unified response envelope and call directly from your backend.
https://openapi.toolkk.com/v1/idcard-area-querycURL Example
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 Example
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 Example
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 Example
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 Example
<?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;Response Example
{
"code": "200",
"message": "success",
"data": {
"areaCode": "110105",
"areaName": "北京市朝阳区"
}
}Examples illustrate the response structure. Actual results depend on the API response.
- Authentication
- Send X-API-Key in request headers
- Rate limit
- 600 req/min
- Timeout
- 5000 ms
Send your API Key in the X-API-Key header from your backend.
Check both HTTP status and business fields before treating a call as successful.
Use retries and backoff together with rate limits in high-frequency scenarios.
Request Fields
Send requests from your server with the key in the X-API-Key header.
Request Fields
The fields below are derived from example JSON for integration reference only.
| Path | Type | Required | Description | Sample |
|---|---|---|---|---|
| idCardNo | string | Unspecified | Unspecified | 110105199003078887 |
Request Example
{
"idCardNo": "110105199003078887"
}- Authentication
- Send X-API-Key in request headers
- Rate limit
- 600 req/min
- Timeout
- 5000 ms
Response Fields
Examples illustrate the response structure. Actual results depend on the API response.
Response Fields
The fields below are derived from example JSON for integration reference only.
| Path | Type | Required | Description | Sample |
|---|---|---|---|---|
| code | string | Unspecified | Unspecified | 200 |
| message | string | Unspecified | Unspecified | success |
| data | object | Unspecified | Unspecified | {...} |
| data.areaCode | string | Unspecified | Unspecified | 110105 |
| data.areaName | string | Unspecified | Unspecified | 北京市朝阳区 |
Response Example
{
"code": "200",
"message": "success",
"data": {
"areaCode": "110105",
"areaName": "北京市朝阳区"
}
}$.code == 200 API overview
Capabilities, use cases, limitations, and frequently asked questions.
Feature Introduction
This API provides a location lookup service for ID card numbers. Users simply input a valid mainland China ID card number, and the system will return the corresponding province and city information. Based on authoritative data sources, this service ensures accurate and real-time results, providing reliable data support for your business.
Application Scenarios
- Real-Name Authentication: Verify whether the ID card information provided by users matches their actual location during registration, transactions, or other sensitive operations to improve authentication accuracy.
- Risk Control: The finance and e-commerce industries can use this API to determine the regional distribution of users. Combined with other risk control strategies, it helps identify potential fraudulent behavior.
- Regional Data Analysis: Enterprises can collect user ID card location data for market analysis and user persona construction to optimize products and marketing strategies.
- Logistics and Delivery Optimization: In the e-commerce or logistics industry, predict the region of the delivery address based on the ID card location to assist in logistics route planning and cost estimation.
- Government Services: Government agencies can verify citizen identity information when processing services to ensure accuracy and compliance.