健康证识别

ocr-health-certPOST
POSThttps://v1.apizero.cn/api/ocr-health-cert

概述

结构化识别从业人员健康证,提取姓名、性别、年龄、体检结论、有效期、体检编码、发证单位等字段。请求传 region=tj 时按天津电子健康证明识别,并返回地区代码与二维码真伪;不传则只返回通用字段。 支持常见纸质证与电子健康证。可以上传整页截图,也可以只截证件卡片。入参为公网图片 URL 或 base64。旧版 6 个字段(name、issued_by、date_of_handling、date_of_issue、date_of_medical_examination、valid_date)保持兼容。 天津证的字段和返回示例见子接口「天津电子健康证明」。

调用约定

  • 网关 · https://v1.apizero.cn
  • 鉴权 · Authorization: Bearer <API Key>
  • 回包 · JSON {code, msg, data}。成功看 code === 0,不要只看 HTTP 200。
/aidocs/ocr-health-cert/raw.md
打开 Markdown

鉴权

需要 API Key(Authorization: Bearer <key>)。登录用户每日免费额度见套餐。

获取 API Key

请求头

Authorizationstring选填

推荐:Bearer <API Key>。兼容请求头 X-API-Key,以及 Query api_key / apikey / key(key 仅当值为 sk_live_/sk_test_/sk_stag_ 形态时生效)。匿名可不传,受每日免费额度限制。

Content-Typestring选填

请求体格式

通用健康证

POSTAPPLICATION/JSON·APPLICATION/JSON

需要 API Key(Authorization: Bearer )。登录用户每日免费额度见套餐。

https://v1.apizero.cn/api/ocr-health-cert?input_type=url&input_data=https%3A%2F%2Fexample.com%2Fhealth-cert.jpg

input_typestring必填

图片传输方式:url(公网图片地址)或 base64

例url

input_datastring必填

图片内容:url 时填 http/https 链接;base64 时填编码串(可含 data:image/xxx;base64, 前缀),≤10MB

例https://example.com/health-cert.jpg

{
  "input_type": "url",
  "input_data": "https://example.com/health-cert.jpg"
}

返回结果

namestring

持证人姓名

genderstring

性别,男或女。票面没有则为空

agestring

年龄。票面没有则为空

birthstring

出生日期,YYYY-MM-DD。能从证件号读出时填写,否则为空

id_numberstring

证件号码。按票面原文返回,掩码星号保留,不补全被挡住的位数

cert_numberstring

健康证编号 / 体检编码

industrystring

行业类别,如公共场所、食品

exam_itemsstring

体检项目。多项用分号连接;能读到结果时为「项目:结果」

exam_resultstring

体检结论,如合格

issued_bystring

发证机关 / 体检单位

date_of_handlingstring

办证日期,YYYY-MM-DD。票面没有则为空

date_of_issuestring

发证日期,YYYY-MM-DD

date_of_medical_examinationstring

体检日期,YYYY-MM-DD。票面没有则为空

valid_datestring

有效期至,YYYY-MM-DD

ocr_msnumber

识别耗时(毫秒)

tipsstring

品牌提示(所有接口统一返回):极数本源 · https://apizero.cn

{
  "code": 0,
  "msg": "成功",
  "data": {
    "name": "张三",
    "gender": "男",
    "age": "32",
    "birth": "",
    "id_number": "110101199001011234",
    "cert_number": "JKZ20240115001",
    "industry": "食品加工",
    "exam_items": "",
    "exam_result": "合格",
    "issued_by": "某某市卫生健康委员会",
    "date_of_handling": "2024-01-15",
    "date_of_issue": "2024-01-20",
    "date_of_medical_examination": "2024-01-10",
    "valid_date": "2025-01-19",
    "ocr_ms": 4200
  },
  "request_id": "abc123",
  "tips": "极数本源 · https://apizero.cn"
}

天津电子健康证明

POSTAPPLICATION/JSON·APPLICATION/JSON

请求参数 region 传 tj 后,按天津电子健康证明识别,并返回 region、二维码真伪等天津字段。不传 region 走通用健康证,不返回这些字段。整页手机截图(含底部须知)或只截中间证件卡片都可以。二维码会提交已接入的天津官方渠道核验:通过且姓名、编号一致时 qr_verify 为真,发证机关、行业、发证日期、有效期、编号和体检结论以官方结果为准。编号或姓名对不上,或官方返回未知健康证明时为伪,不改写姓名和发证机关。图中解不出二维码时为未识别,文字字段仍返回。渠道未接入或请求失败时为无法核验;编号与票面一致但渠道未接入时同样是无法核验,不会判伪。红章挡住的检查项目可能只有名称、没有检测结果。

https://v1.apizero.cn/api/ocr-health-cert?region=tj&input_type=url&input_data=https%3A%2F%2Fexample.com%2Fhealth-cert.jpg

region(地区)string必填

版式。天津电子健康证明传 tj。传 tj 后按天津版式识别,并返回 region、二维码真伪等天津字段。不传则走通用健康证,不返回这些字段

例tj

input_typestring必填

图片传输方式:url(公网图片地址)或 base64

例url

input_datastring必填

图片内容:url 时填 http/https 链接;base64 时填编码串(可含 data:image/xxx;base64, 前缀),≤10MB

例https://example.com/health-cert.jpg

{
  "region": "tj",
  "input_type": "url",
  "input_data": "https://example.com/health-cert.jpg"
}

返回结果

namestring

持证人姓名

genderstring

性别,男或女

agestring

年龄

birthstring

出生日期,YYYY-MM-DD。从证件号中已露出的出生日期读出,不补全掩码

id_numberstring

证件号码。掩码星号按票面保留

industrystring

行业类别。查验为真时,以官方行业名称为准

exam_itemsstring

检查项目与检测结果,多项用分号连接,单项为「项目:结果」。红章挡住的行可能只有项目名。常见五项:细菌性痢疾、伤寒、病毒性肝炎(甲肝、戊肝)、活动性肺结核、化脓性或渗出性皮肤病

exam_resultstring

体检结论。证件写明合格,且没有不合格项时为合格。查验为真时,官方状态为合格或临期写合格,不合格写不合格;逾期不改结论

issued_bystring

发证机关。查验为真时改为官方机构名称

date_of_handlingstring

办证日期。天津电子证通常为空

date_of_issuestring

发证日期,YYYY-MM-DD。查验为真时以官方开始日期为准

date_of_medical_examinationstring

体检日期。天津电子证通常为空

valid_datestring

有效期至,YYYY-MM-DD。查验为真时以官方截止日期为准

cert_numberstring

编号,如 (M)DEMO202006010001。查验为真时以官方 markCode 为准

regionstring

地区代码。天津市电子健康证明固定为 tj。其它地区不返回此字段

qrcodestring

证件二维码原文,通常是官方查验链接。识别不到时为空字符串

qr_verifystring

真伪。真:官方查验通过,且姓名、编号与证件一致。伪:编号或姓名与官方记录不符,或官方返回未知健康证明;此时不改写姓名和发证机关。未识别:没有解出二维码,其余文字字段仍返回。无法核验:二维码不是已接入的天津查验渠道,或请求失败。编号与票面一致但渠道未接入时也是无法核验,不会判伪

qr_statestring

官方状态:合格、临期、逾期、不合格。没有查到时为空。逾期表示已过有效期,不表示证件是假的

qr_verify_msgstring

查验说明。例如「官方查验为合格」「官方查验为临期」「证明真实,当前已逾期」「未知健康证明」

ocr_msnumber

识别耗时(毫秒)

tipsstring

品牌提示(所有接口统一返回):极数本源 · https://apizero.cn

{
  "code": 0,
  "msg": "成功",
  "data": {
    "name": "张三",
    "gender": "女",
    "age": "28",
    "birth": "1998-01-01",
    "id_number": "11010119980101****",
    "industry": "公共场所",
    "exam_items": "细菌性痢疾:未检出;伤寒:未检出;病毒性肝炎(甲肝、戊肝):未检出;活动性肺结核:未检出;化脓性或渗出性皮肤病:无",
    "exam_result": "合格",
    "issued_by": "某某市卫生服务中心",
    "date_of_handling": "",
    "date_of_issue": "2020-06-01",
    "date_of_medical_examination": "",
    "valid_date": "2021-06-01",
    "cert_number": "(M)DEMO202006010001",
    "region": "tj",
    "qrcode": "https://example.com/health-check?markCode=(M)DEMO202006010001",
    "qr_verify": "真",
    "qr_state": "合格",
    "qr_verify_msg": "官方查验为合格",
    "ocr_ms": 1800
  },
  "request_id": "abc123",
  "tips": "极数本源 · https://apizero.cn"
}

请求示例

示例都是服务端写法。Python / JavaScript 各有常规写法和官方库。

curl -sS -X POST "https://v1.apizero.cn/api/ocr-health-cert" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input_type": "url",
  "input_data": "https://example.com/health-cert.jpg"
}'

错误码

先看业务 code。HTTP 也可能不是 200。

0200

成功

4000400

参数错误

4011401

API Key 无效

4013403

API Key 已暂停

4014403

当前 IP 不在 Key 白名单

4015401

此接口需要 API Key

4022402

余额不足

4029429

调用过快(QPS)

4030429

今日免费额度已用完

4040503

接口已下线

4041404

接口不存在

5000500

服务器内部错误

5020502

上游暂时不可用

5021502

上游返回格式异常

5030502

暂无可用节点

调用限制

计费模式
完全免费
QPS 限制
QPS 2
登录免费额度
20 次(已认证)
匿名每日额度
无
黄金会员
每天 50,000 次 · QPS 10
钻石会员
每天 100,000 次 · QPS 30
企业会员
每天 1,000,000 次 · QPS 120

购买套餐、看评价请走商城详情。 购买 / 调试

更新日志

  • v1.02026-06-04

    首次上线,返回 6 个结构化字段,支持 URL / base64 输入。

  • v1.12026-07-10

    切换本平台自建识别引擎,扩展返回字段(性别/年龄/体检结论/体检编码/行业等),旧 6 字段保持兼容。

  • v1.22026-10-11

    天津市电子健康证明单独识别,并返回 region、二维码与官方真伪。其它地区的返回字段不变。

  • v1.32026-10-12

    天津子接口传 region=tj 后走天津识别和天津返回。不传 region 仍是通用健康证,不返回 region 和二维码字段。