雲尚API

身份證二要素查驗

查驗姓名與身份證字號是否一致,資料來源權威,即時回傳結果。適合註冊、實名認證、風控等場景。套餐制,每次呼叫扣減 1 次。

介面資訊

項目說明
介面位址POST /api/v3/idcard2check
計費方式套餐制

請求參數

參數類型必填說明
namestring真實姓名
idcardstring身份證字號

請求範例

PHP

<?php
$app_id = 'YOUR_APP_ID';
$app_key = 'YOUR_APP_KEY';
$url = 'https://yunsapi.com/api/v3/idcard2check';
$params = ['name' => '张三', 'idcard' => '440301199512073421'];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'X-APP-ID: ' . $app_id,
    'X-APP-KEY: ' . $app_key,
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

$resp = curl_exec($ch);
curl_close($ch);

echo $resp;

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class IdcardDemo {
    public static void main(String[] args) throws Exception {
        String appId = "YOUR_APP_ID";
        String appKey = "YOUR_APP_KEY";
        String url = "https://yunsapi.com/api/v3/idcard2check";
        String body = "{\"name\":\"张三\",\"idcard\":\"440301199512073421\"}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest req = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Content-Type", "application/json")
                .header("X-APP-ID", appId)
                .header("X-APP-KEY", appKey)
                .POST(HttpRequest.BodyPublishers.ofString(body))
                .build();

        HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
        System.out.println(resp.body());
    }
}

回應範例

{
    "code": 0,
    "msg": "success",
    "data": {
        "name": "张三",
        "status": "1",
    },
    "request_id": "req_xxx"
}

回應參數

參數類型說明
data.namestring查驗的姓名
data.statusstring1 表示資訊一致,0 表示不一致

說明:姓名與身份證字號不一致時,介面回傳業務錯誤碼 1100,可透過 data.status 或錯誤碼判斷查驗結果。