呼叫價格
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介面簡介
介面功能、應用情境、使用限制與常見問題。
功能介紹
身分證二要素核驗API提供了一種快速、準確地驗證使用者姓名與身分證號碼一致性的能力。系統透過將使用者提交的身分資訊與公安部權威資料來源進行即時比對,返回核驗結果,確保身分資訊的真實性和有效性。
應用場景
- 使用者註冊與實名認證: 在金融、社交、電商等平台使用者註冊時,要求進行實名認證,確保使用者身分的真實性,防止虛假註冊。
- 業務合規與風險控制: 適用於需要進行身分核驗的業務場景,如貸款申請、合約簽署、帳號找回等,降低業務風險,滿足合規要求。
- 防範欺詐: 在交易或服務過程中,核驗使用者身分資訊,有效識別並防範冒用他人身分進行欺詐的行為。
使用說明
呼叫本API需要提供待核驗的姓名(name)和身分證號碼(idNumber)參數。API將返回核驗結果,包括是否匹配以及匹配狀態碼。請確保傳入的姓名和身分證號碼格式正確,否則可能導致核驗失敗。建議在整合前仔細閱讀介面文件中關於請求參數、回應參數及錯誤碼的詳細說明。