身份证识别 API（idcard.ocr）

curl -s -X POST "https://api.xujian.tech/openapi/idcard/ocr" \
  -H "X-API-Key: 你的APIKey" \
  -F "file=@/path/to/idcard.jpg"

curl -s -X POST "https://api.xujian.tech/openapi/idcard/ocr" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: 你的APIKey" \
  -d '{"image": "图片的 base64 内容（可带 data:image/jpeg;base64, 前缀）"}'

curl -s -X POST "https://api.xujian.tech/openapi/idcard/ocr" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: 你的APIKey" \
  -d '{"imageUrl": "https://example.com/idcard.jpg"}'

{
  "code": 0,
  "msg": "success",
  "data": {
    "side": "front",
    "sideText": "人像面",
    "name": "张三",
    "gender": "男",
    "nation": "汉",
    "birthDate": "1990-05-20",
    "address": "重庆市铜梁区白龙大道88号",
    "idNo": "500224199005201234",
    "issueOrg": "",
    "validFrom": "",
    "validTo": "",
    "validPeriod": "",
    "confidence": 98.50,
    "qualityNote": "图片清晰",
    "apiCode": "idcard.ocr",
    "apiName": "身份证识别",
    "chargeType": "PER_CALL",
    "balance": 99.9500,
    "costMs": 3200
  }
}

{
  "code": 500,
  "msg": "未能识别出身份证信息，请上传清晰的身份证人像面或国徽面照片（本次调用已计费）",
  "data": null
}

{
  "code": 500,
  "msg": "图片大小不能超过 10MB",
  "data": null
}

// 方式一：multipart 上传文件
String body = HttpRequest.post("https://api.xujian.tech/openapi/idcard/ocr")
        .header("X-API-Key", apiKey)
        .form("file", new File("/path/to/idcard.jpg"))
        .timeout(60000)
        .execute()
        .body();

// 方式二：JSON + base64
JSONObject req = JSONUtil.createObj().set("image", Base64.encode(new File("/path/to/idcard.jpg")));
String body2 = HttpRequest.post("https://api.xujian.tech/openapi/idcard/ocr")
        .header("Content-Type", "application/json")
        .header("X-API-Key", apiKey)
        .timeout(60000)
        .body(req.toString())
        .execute()
        .body();

JSONObject json = JSONUtil.parseObj(body);
if (json.getInt("code") != 0) {
    // 注意：识别失败同样已扣费，不要无脑重试
    System.out.println("识别失败：" + json.getStr("msg"));
    return;
}
JSONObject data = json.getJSONObject("data");
System.out.printf("%s｜%s｜%s｜置信度 %s%n",
        data.getStr("name"), data.getStr("idNo"),
        data.getStr("address"), data.getBigDecimal("confidence"));

import base64
import requests


def recognize(api_key: str, path: str):
    """识别身份证；识别失败也会扣费，不要直接重试用同一张图"""
    with open(path, "rb") as f:
        b64 = base64.b64encode(f.read()).decode()

    resp = requests.post(
        "https://api.xujian.tech/openapi/idcard/ocr",
        json={"image": b64},
        headers={"Content-Type": "application/json", "X-API-Key": api_key},
        timeout=60,
    )
    result = resp.json()
    if result.get("code") != 0:
        print("识别失败（已扣费）：", result.get("msg"))
        return None
    return result["data"]


if __name__ == "__main__":
    data = recognize("你的APIKey", "idcard.jpg")
    if data:
        print(data["name"], data["idNo"], data["confidence"])

// 浏览器端：直接用 FormData 上传用户选择的图片
const form = new FormData();
form.append("file", fileInput.files[0]);

const resp = await fetch("https://api.xujian.tech/openapi/idcard/ocr", {
  method: "POST",
  headers: { "X-API-Key": API_KEY },   // 不要手动设置 Content-Type，浏览器会自动带上 boundary
  body: form,
});

const { code, msg, data } = await resp.json();
if (code === 0) {
  console.log(`${data.name}｜${data.idNo}｜置信度 ${data.confidence}`);
} else {
  console.warn("识别失败（可能已扣费）：", msg);
}