POST已开放idcard-validate

身份证二要素核验

用于核验用户提供的姓名和身份证号码是否真实有效且匹配。通过与权威数据源比对，快速验证身份信息的准确性。

接入文档

功能介绍

身份证二要素核验API提供了一种快速、准确地验证用户姓名与身份证号码一致性的能力。系统通过将用户提交的身份信息与公安部权威数据源进行实时比对，返回核验结果，确保身份信息的真实性和有效性。

应用场景

用户注册与实名认证: 在金融、社交、电商等平台用户注册时，要求进行实名认证，确保用户身份的真实性，防止虚假注册。
业务合规与风险控制: 适用于需要进行身份核验的业务场景，如贷款申请、合同签署、账号找回等，降低业务风险，满足合规要求。
防范欺诈: 在交易或服务过程中，核验用户身份信息，有效识别并防范冒用他人身份进行欺诈的行为。

使用说明

调用本API需要提供待核验的姓名（name）和身份证号码（idNumber）参数。API将返回核验结果，包括是否匹配以及匹配状态码。请确保传入的姓名和身份证号码格式正确，否则可能导致核验失败。建议在集成前仔细阅读接口文档中关于请求参数、响应参数及错误码的详细说明。

接入示例代码

提供 Shell、Python、Go、Java、PHP 等常见接入示例，便于直接接到现有项目里。

Shell 示例Python 示例Go 示例Java 示例PHP 示例

Shell 示例

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;

请求示例

{
  "name": "张三",
  "idCardNo": "110105199003078887"
}

响应示例

{
  "code": "SUCCESS",
  "message": "success",
  "data": {
    "result": "一致",
    "desc": "姓名和身份证号一致",
    "sex": "男",
    "birthday": "19900307",
    "address": "北京市西城区"
  }
}

请求字段

以下字段根据示例 JSON 自动提取，仅作接入参考。

字段路径	类型	示例值
name	string	张三
idCardNo	string	110105199003078887

响应字段

以下字段根据示例 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	北京市西城区