OCR 证件识别服务 API 文档#

概述#

认证方式#

OCR 证件识别#

请求方式#

文件上传方式#

URL 方式（JSON Body）#

URL 方式（Form Data）#

请求参数#

公共响应字段#

成功响应示例#

{
  "success": true,
  "cardType": "身份证正面",
  "tokensIn": 1523,
  "tokensOut": 89,
  "result": [
    {
      "type": "身份证正面",
      "name": "张三",
      "gender": "男",
      "ethnicity": "汉",
      "birth_date": "1990-01-01",
      "address": "北京市朝阳区XX路XX号",
      "id_number": "110101199001011234"
    }
  ],
  "rawResult": "",
  "filePath": "/path/to/idcard.jpg",
  "fileName": "idcard.jpg"
}

注意：result[] 中的具体字段根据识别出的证件类型动态变化，各证件类型返回的实体字段详见下方 各证件类型返回字段。

错误响应#

HTTP 状态码#

401 - 缺少认证头#

{
  "error": "Missing X-Auth-Key header"
}

403 - 认证密钥无效#

{
  "error": "Invalid auth key"
}

400 - 缺少必要参数#

{
  "success": false,
  "cardType": "",
  "tokensIn": 0,
  "tokensOut": 0,
  "result": [],
  "rawResult": "",
  "filePath": "",
  "fileName": "",
  "error": "Missing required parameter: file or file_url"
}

413 - 文件大小超限#

{
  "success": false,
  "cardType": "",
  "tokensIn": 0,
  "tokensOut": 0,
  "result": [],
  "rawResult": "",
  "filePath": "",
  "fileName": "",
  "error": "File size exceeds maximum limit of 10MB"
}

500 - 服务内部错误#

{
  "success": false,
  "cardType": "",
  "tokensIn": 0,
  "tokensOut": 0,
  "result": [],
  "rawResult": "",
  "filePath": "https://example.com/idcard.jpg",
  "fileName": "idcard.jpg",
  "error": "具体错误信息"
}

支持的证件类型#

各证件类型返回字段#

身份证 (idcard_front)#

行驶证正面 (driver_license)#

驾驶证正面 (vehicle_license)#

电子驾驶证 (vehicle_license_electronic)#

护照 (passport)#

户口本 (household)#

银行卡 (bank_card)#

营业执照 (business_license)#

结婚证 (marriage_cert)#

离婚证 (divorce_cert)#

军官证 (army_cert)#

社保卡 (social_card)#

出生医学证明 (bornmedical_cert)#

车辆登记证 (vehicle_registration)#

车辆合格证 (vehicle_conformity_cert)#

车辆货物进口证明书 (import_vehicle_cert)#

机动车电子保单商业险 (e_policy_commercial)#

机动车电子保单交强险 (e_policy_compulsory)#

机动车电子保单驾意险 (e_policy_driver)#

注意：驾意险 prompt 中还包含投保产品名称、投保人联系人Email 等字段，这些字段的映射 key 保留中文原名。

机动车销售统一发票 (invoice_new_car)#

二手车销售统一发票 (invoice_used_car)#

增值税发票 (invoice_vat)#

火车票 (train_ticket)#

出租车票 (taxi_ticket)#

开户许可证 (account_opening_permit_cert)#

组织机构代码证 (org_code_cert)#

房产证 (house_property_cert)#

不动产登记证 (real_estate_reg_cert)#

门诊收费票据 (outpatient_receipt)#

出院小结/病例 (discharge_summary)#

医疗费用清单/结算单 (medical_expense_list)#

化验报告单 (lab_report)#

提示：以上各证件类型的返回字段均为识别结果中可能出现的字段，实际返回字段取决于图片内容和模型识别结果。如遇图片模糊或字段缺失，对应值可能为空字符串或 ?。部分证件类型（电子保单商业险、增值税发票、门诊收费票据、医疗费用清单、化验报告单等）的返回数据中除基础字段外还包含数组类型的明细列表。