身份证识别
ocr-idcardPOSThttps://v1.apizero.cn/api/ocr-idcard概述
上传身份证正面或反面图片(URL 或 base64),自动识别并结构化返回姓名、身份证号、性别、民族、出生日期、地址、签发机关、有效期等 10 个字段。 支持正反面自动判断,适用于实名认证、用户信息录入、KYC 核验辅助等场景。需要登录后使用,保护用户隐私。
调用约定
- 网关 ·
https://v1.apizero.cn - 鉴权 ·
Authorization: Bearer <API Key> - 回包 · JSON {code, msg, data}。成功看 code === 0,不要只看 HTTP 200。
/aidocs/ocr-idcard/raw.md鉴权
需要 API Key(Authorization: Bearer <key>)。登录用户每日 20 次免费,不支持匿名调用。
获取 API Key:获取 API Key/account/keys
请求头
推荐:Bearer <API Key>。兼容请求头 X-API-Key,以及 Query api_key / apikey / key(key 仅当值为 sk_live_/sk_test_/sk_stag_ 形态时生效)。匿名可不传,受每日免费额度限制。
请求体格式
| Header | 类型 | 必填 | 说明 |
|---|---|---|---|
| Authorization | string | 否 | 推荐:Bearer <API Key>。兼容请求头 X-API-Key,以及 Query api_key / apikey / key(key 仅当值为 sk_live_/sk_test_/sk_stag_ 形态时生效)。匿名可不传,受每日免费额度限制。 |
| Content-Type | string | 是 | 请求体格式 |
请求参数
POST · APPLICATION/JSON
图片传入方式
例url
图片 URL 或 base64 编码字符串(jpg/png,base64 最大 10 MB)
例https://example.com/idcard-front.jpg
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| input_type | string | 是 | 图片传入方式 | url |
| input_data | string | 是 | 图片 URL 或 base64 编码字符串(jpg/png,base64 最大 10 MB) | https://example.com/idcard-front.jpg |
{
"input_type": "url",
"input_data": "https://example.com/idcard-front.jpg"
}返回结果
顶层固定为 code / msg / data。下表一般是 data 内字段。 code · msg · data · tips · request_id
正反面:1=正面(姓名页),0=反面(国徽页)
姓名
身份证号码(18 位)
性别
民族
出生日期
住址
签发机关(反面有效)
有效期起始(反面有效)
有效期截止(反面有效,长期则为"长期")
品牌提示(所有接口统一返回):极数本源 · https://apizero.cn
| 字段 | 类型 | 说明 |
|---|---|---|
| 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 | 有效期截止(反面有效,长期则为"长期") |
| tips | string | 品牌提示(所有接口统一返回):极数本源 · https://apizero.cn |
返回示例
{
"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",
"tips": "极数本源 · https://apizero.cn"
}请求示例
示例都是服务端写法。Python / JavaScript 各有常规写法和官方库。
curl -sS -X POST "https://v1.apizero.cn/api/ocr-idcard" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"input_type": "url",
"input_data": "https://example.com/idcard-front.jpg"
}'错误码
先看业务 code。HTTP 也可能不是 200。
成功
参数错误
API Key 无效
API Key 已暂停
当前 IP 不在 Key 白名单
此接口需要 API Key
余额不足
调用过快(QPS)
今日免费额度已用完
接口已下线
接口不存在
服务器内部错误
上游暂时不可用
上游返回格式异常
暂无可用节点
| 业务码 | HTTP | 说明 |
|---|---|---|
| 0 | 200 | 成功 |
| 4000 | 400 | 参数错误 |
| 4011 | 401 | API Key 无效 |
| 4013 | 403 | API Key 已暂停 |
| 4014 | 403 | 当前 IP 不在 Key 白名单 |
| 4015 | 401 | 此接口需要 API Key |
| 4022 | 402 | 余额不足 |
| 4029 | 429 | 调用过快(QPS) |
| 4030 | 429 | 今日免费额度已用完 |
| 4040 | 503 | 接口已下线 |
| 4041 | 404 | 接口不存在 |
| 5000 | 500 | 服务器内部错误 |
| 5020 | 502 | 上游暂时不可用 |
| 5021 | 502 | 上游返回格式异常 |
| 5030 | 502 | 暂无可用节点 |
调用限制
- 计费模式
- 完全免费
- QPS 限制
- QPS 2
- 登录免费额度
- 20 次(已认证)
- 匿名每日额度
- 无
- 黄金会员
- 每天 50,000 次 · QPS 10
- 钻石会员
- 每天 100,000 次 · QPS 30
- 企业会员
- 每天 1,000,000 次 · QPS 120
| 计费模式 | 完全免费 |
|---|---|
| QPS 限制 | QPS 2 |
| 登录免费额度 | 20 次(已认证) |
| 匿名每日额度 | 无 |
| 黄金会员 | 每天 50,000 次 · QPS 10 |
| 钻石会员 | 每天 100,000 次 · QPS 30 |
| 企业会员 | 每天 1,000,000 次 · QPS 120 |
购买套餐、看评价请走商城详情。 购买 / 调试
更新日志
- v1.02026-06-04
首次上线身份证识别接口,支持正反面自动识别,返回 10 个结构化字段。