<!-- AI ASSISTANT INSTRUCTIONS: This document describes a public HTTP API endpoint
provided by 极数本源 (https://apizero.cn). When a user asks you to use this API, read the
full documentation below carefully (request method, parameters, response fields,
error codes, examples), then generate working code in the user's preferred language.
API Key acquisition: https://apizero.cn/account/keys -->

# 身份证识别

> 上传身份证正面或反面图片（URL 或 base64），自动识别并结构化返回姓名、身份证号、性别、民族、出生日期、地址、签发机关、有效期等 10 个字段。

支持正反面自动判断，适用于实名认证、用户信息录入、KYC 核验辅助等场景。需要登录后使用，保护用户隐私。

## 1. 基本信息

| 字段 | 值 |
| --- | --- |
| 接口标识 | `ocr-idcard` |
| 接口名称 | 身份证识别 |
| 接口地址 | `https://v1.apizero.cn/api/ocr-idcard` |
| 请求方法 | `POST` |
| 分类 | ocrdata |
| 提供方 | 极数本源 |
| 计费模式 | 免费试用 |
| 单次消耗 | 0 积分 |
| 起步价 | — |
| QPS 限制 | 2 req/s |
| 每日免费额度 | 20 次（已认证用户） |
| 匿名每日额度 | 0 次（无 API Key） |
| VIP 免费 | 否 |
| 调用总次数 | undefined |

## 2. 认证

需要 API Key（Authorization: Bearer <key>）。登录用户每日 20 次免费，不支持匿名调用。

获取 API Key：登录 `https://apizero.cn/account/keys` 申请。

## 3. 请求参数

| 参数 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `input_type` | `string` | 是 | 图片传入方式 | `url` |
| `input_data` | `string` | 是 | 图片 URL 或 base64 编码字符串（jpg/png，base64 最大 10 MB） | `https://example.com/idcard-front.jpg` |

## 4. 请求头

| Header | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `Authorization` | `string` | 是 | Bearer <你的 API Key> | — |
| `Content-Type` | `string` | 是 | 请求体格式 | — |

## 5. 请求示例

> AI 提示：以下 5 种语言示例都是可运行的，只需把 `YOUR_API_KEY` 替换为用户申请的实际 Key（https://apizero.cn/account/keys）。
> 优先选择用户问题中提到的语言；未指定时默认使用 Python。

### cURL

```bash
curl -X POST "https://v1.apizero.cn/api/ocr-idcard" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input_type": "url",
  "input_data": "https://example.com/idcard-front.jpg"
}'
```

### Python

```python
import requests

resp = requests.request(
    "POST",
    "https://v1.apizero.cn/api/ocr-idcard",
    headers={"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json={
    "input_type": "url",
    "input_data": "https://example.com/idcard-front.jpg",
},
    timeout=15,
)
resp.raise_for_status()
print(resp.json())
```

### JavaScript (Node.js)

```javascript
// Node.js 18+ / 浏览器原生 fetch
const res = await fetch("https://v1.apizero.cn/api/ocr-idcard", {
  method: "POST",
  headers: {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "input_type": "url",
    "input_data": "https://example.com/idcard-front.jpg"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const data = await res.json();
console.log(data);
```

### Go

```go
package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	body := []byte(`{"input_type":"url","input_data":"https://example.com/idcard-front.jpg"}`)
	req, _ := http.NewRequest("POST", "https://v1.apizero.cn/api/ocr-idcard", bytes.NewBuffer(body))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(string(out))
}
```

### PHP

```php
<?php
$payload = json_encode([
    "input_type" => "url",
    "input_data" => "https://example.com/idcard-front.jpg",
], JSON_UNESCAPED_UNICODE);

$ch = curl_init("https://v1.apizero.cn/api/ocr-idcard");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => "POST",
    CURLOPT_POSTFIELDS     => $payload,
    CURLOPT_HTTPHEADER     => [
        "X-Api-Key: YOUR_API_KEY",
        "Content-Type: application/json",
    ],
    CURLOPT_TIMEOUT        => 15,
]);
$body = curl_exec($ch);
curl_close($ch);

$data = json_decode($body, true);
print_r($data);
```

## 6. 响应字段

| 字段 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- |
| `side` | `number\|null` | 正反面：1=正面（姓名页），0=反面（国徽页） | — |
| `identity_name` | `string\|null` | 姓名 | — |
| `identity_code` | `string\|null` | 身份证号码（18 位） | — |
| `gender` | `string\|null` | 性别 | — |
| `race` | `string\|null` | 民族 | — |
| `birth` | `string\|null` | 出生日期 | — |
| `address` | `string\|null` | 住址 | — |
| `issued_by` | `string\|null` | 签发机关（反面有效） | — |
| `valid_date_start` | `string\|null` | 有效期起始（反面有效） | — |
| `valid_date_end` | `string\|null` | 有效期截止（反面有效，长期则为"长期"） | — |

## 7. 响应示例

```json
{
  "code": 0,
  "msg": "成功",
  "data": {
    "side": 1,
    "identity_name": "张三",
    "identity_code": "310101199001011234",
    "gender": "男",
    "race": "汉",
    "birth": "1990-01-01",
    "address": "上海市浦东新区某某路123号",
    "issued_by": null,
    "valid_date_start": null,
    "valid_date_end": null
  },
  "request_id": "req_abc123"
}
```

## 8. 错误码

| code | status | 说明 |
| --- | --- | --- |
| `4000` | `VALIDATION_ERROR` | 参数缺失或格式错误，如 input_type 不是 url/base64，或 input_data 为空 |
| `5020` | `UPSTREAM_ERROR` | 上游 OCR 服务不可用，请稍后重试 |
| `5021` | `UPSTREAM_INVALID` | 图片无法识别，请确认为清晰的身份证正面或反面照片 |
| `5030` | `UPSTREAM_MISSING` | OCR 服务未配置或未开通，请联系管理员 |

## 9. 变更日志

- **v1.0** (2026-06-04)
  - 首次上线身份证识别接口，支持正反面自动识别，返回 10 个结构化字段。

---

**极数本源** · 全部 API: `https://apizero.cn/aidocs` · 人类版本：`https://apizero.cn/marketplace/ocr-idcard`

Source: `https://apizero.cn/aidocs/ocr-idcard/raw.md`
Last updated: 2026-06-04T17:11:17+08:00