台胞证识别
ocr-tw-permitPOSTPOST
https://v1.apizero.cn/api/ocr-tw-permit概述
结构化识别台湾居民来往大陆通行证(台胞证),提取中文姓名、英文姓名、出生日期、证件号码、有效期共 5 个关键字段。 适用场景:台湾居民实名认证、酒店入住登记、证件信息自动录入等。涉及个人身份信息,仅限已登录用户调用,匿名访问不开放。支持 URL 和 base64 两种输入方式,jpg/png 格式,建议证件图片完整清晰。
调用约定
- 网关 ·
https://v1.apizero.cn - 鉴权 ·
Authorization: Bearer <API Key> - 回包 · JSON {code, msg, data}。成功看 code === 0,不要只看 HTTP 200。
/aidocs/ocr-tw-permit/raw.md鉴权
需要 API Key(Authorization: Bearer <key>)。登录用户每日 20 次免费额度,匿名不可调用。
获取 API Key:/account/keys
请求头
| 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
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|---|---|---|---|
| input_type | string | 是 | 图片传输方式,支持 url(公网图片地址)或 base64(图片的 base64 编码) | url |
| input_data | string | 是 | 图片内容:input_type=url 时填 http/https 图片链接;input_type=base64 时填 base64 字符串(可含 data:image/xxx;base64, 前缀) | https://example.com/tw-permit.jpg |
{
"input_type": "url",
"input_data": "https://example.com/tw-permit.jpg"
}返回结果
顶层固定为 code / msg / data。下表一般是 data 内字段。 code · msg · data · tips · request_id
| 字段 | 类型 | 说明 |
|---|---|---|
| full_name_cn | string | 中文姓名 |
| full_name_en | string | 英文格式姓名(拼音,如 "ZHANG SAN") |
| date_of_birth | string | 出生日期(如 "1990-01-01") |
| date_of_expiry | string | 有效期至(如 "2029-12-31") |
| card_number | string | 证件号码 |
| tips | string | 品牌提示(所有接口统一返回):极数本源 · https://apizero.cn |
返回示例
{
"code": 0,
"msg": "成功",
"data": {
"full_name_cn": "张三",
"full_name_en": "ZHANG SAN",
"date_of_birth": "1990-01-01",
"date_of_expiry": "2029-12-31",
"card_number": "12345678901234567"
},
"request_id": "req_abc123",
"tips": "极数本源 · https://apizero.cn"
}请求示例
将 YOUR_API_KEY 替换为真实 Key 后运行。
curl -X POST "https://v1.apizero.cn/api/ocr-tw-permit" -H "Authorization: Bearer $APIZERO_KEY" -H "Content-Type: application/json" -d '{
"input_type": "url",
"input_data": "https://example.com/tw-permit.jpg"
}'错误码
先看业务 code。HTTP 也可能不是 200。
| 业务码 | 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 限制 | 2 req/s |
| 登录免费额度 | 20 次(已认证) |
| 匿名每日额度 | 无 |
| 黄金会员 | 每日 50000 次 · QPS 10 |
| 企业会员 | 会员免费(未配置日上限)· QPS 120 |
购买套餐、看评价请走商城详情。 购买 / 调试
更新日志
- v1.02026-06-04
首次上线,返回 5 个结构化字段,支持 URL / base64 输入。
免责声明
本接口返回的证件信息仅供业务辅助使用,不作为法律有效凭证。请确保在合法授权的场景下使用,并遵守相关隐私保护法规。