接入文档
OCR识别(海外版)
智慧文档识别
智慧文档识别

# 1 功能描述

本产品提供一站式非证件类图像与文档智能识别服务,支持对各类非证件图片、PDF 文件等进行结构化信息提取与内容解析,覆盖日常单据、票据、表单、合同、纸质文件等多类非证件场景。服务具备高兼容的文件与图像解析能力,支持多页 PDF 识别、图片内容提取、版式还原、文字结构化输出等核心能力,满足海外业务中各类非证件类文档自动化录入、信息提取、资料归档等全场景需求。

# 2 使用说明

# 2.1 调用URL

新加坡地址:https://api-sgp.yljz.com/finauth/v1/anydoc

# 2.2 调用方法

请求方式:POST
请求格式:form-data
说明:客户传入通过apikey和secret生成的加密签名sign,同时提供需识别的文件,我方返回识别结果。

# 3 请求参数

可选/必选 字段 参数类型 参数说明
必选 sign String 签名生成规则参考鉴权说明
必选 sign_version String 签名算法版本,请传递:hmac_sha1
必选 file File (9M以内),支持图片或PDF,具体以每个应用支持的文档类型为准,图片支持:.jpg, .jpeg, .png, gif, webp格式
可选 inputs JSON String 依据解析文档类型/app_id而定,需要传入时传入。格式:'inputs':json.dumps({"key":"xxx"}),inputs对应的格式需要是字符串。
必选 app_id String 不同的识别能力对应不同的app_id,请参考下面的“数据字典”

# 4 返回参数

接口调用成功时返回

字段 类型 参数说明
request_id String 用于区分每一次请求的唯一的字符串。
error_message String 错误信息。当请求失败时才会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。
time_used Int 整个请求所花费的时间,单位为毫秒。
result Object 不同的app_id/文档类型返回的结构不同,参考“数据字典”
+ pages Int 消耗的页数,页数*单价就是本次的实际价格,pages大于0/非空时计费
+ outputs JSON 文档识别结果JSON会封装在outputs中输出
++ text JSON 这里包含对应appid返回的内容

# 5 数据字典

# 5.1 智慧文档识别能力(app_id)

分类 app_id 识别能力说明
智能审核 builtin-ySmthSJqzQ3bN0Z9Y0 图片质量分析检测
智能审核 builtin-lcDhAaeQMJcOandoBP 图片PS检测
资信证明 builtin-0nZ0bZ09s9HqfjckoF 简版通用水电煤燃气账单中识别姓名及地址信息
资信证明 builtin-8qUxGuXkYTm4U3lLxb 详版燃气账单识别
资信证明 builtin-u6OXNzMM68cMyqfCH8 详版电费单识别
资信证明 builtin-yQU9ZpfsRuFeNUy4aw M-PESA流水证明文件识别
资信证明 builtin-Dr2fttpaJzyOg2oGYZ 银行流水文件进行识别
资信证明 builtin-ftEObTXXN9m03VXmwZ 非标类交易/流水识别
资信证明 builtin-siyppaCoUSYW1VImX9 企业注册证明文件的识别
票据 builtin-AsGltresBLOGouN1Pr 购物小票进行识别
票据 builtin-FgYvNQQFGQ3o7qBVOe 发票文件进行识别
卡证 builtin-GehZrc2wddibKXSAWb 全球护照识别及判断照片中是否为护照
卡证 builtin-reKEg1UVsgE5yGtNO7 全球卡证文件出生日期与年龄解析
卡证 builtin-nGd1eMoYS2mBKgjYQ6 中国台湾物权证明识别
卡证 builtin-ZXELuKZ7SXPGWmixZE 中国台湾不动产权证识别
卡证 builtin-SrFi52OPlDGKSQmjvZ 中国台湾身份证识别
卡证 builtin-UqDwMvWDRD05zCm0BG 中国台湾居民居住证
卡证 builtin-laCUS0pQTRGOrEas0l 菲律宾13类卡证的识别,UMID=统一多用途身份证,SSS_ID=社会保障系统编号,PASSPORT=护照,DRIVER_LICENSE=驾驶证,NATIONAL_ID=国家身份证,POSTAL_ID=邮政身份证,PRC_ID=专业注册委员会身份证,TIN_ID=纳税人身份证,VOTER_ID=选民证,OWWA_ID=海外劳工福利署身份证,GSIS_ID=政府服务保险系统身份证,PHILHEALTH_ID=菲律宾健康保险身份证,PAGIBIG_ID=Pag-IBIG住房公积金会员身份证
卡证 builtin-5Rfhqo1A3MGROHUNJJ 巴基斯坦5类身份证的识别,“cnic”巴基斯坦境内公民身份证。 “snic”带芯片的巴基斯坦智能公民身份证。“nicop”海外巴基斯坦公民身份证。 “poc”面向具有巴基斯坦血统或联系的外国公民证件。“arc”面向在巴基斯坦登记的外国人证件。
卡证 builtin-6UOFfK0g1gMvgCHx19 东帝汶证件(身份证/护照/驾驶证/选民证)
卡证 builtin-cimngo8Kfy06XJ6Wk8 尼日利亚证件(身份证/护照/驾驶证/选民证)
卡证 builtin-VaJK7W9EV8wIOcV2pe 巴西证件(身份证/护照/驾驶证/税卡)
卡证 builtin-86og0wZ7HLhSXlYG7p 越南身份证
卡证 builtin-i88oDw1H2dbkpAXzJ3 泰国身份证
卡证 builtin-IPC3Peq8NRXRxr4ZbE 柬埔寨身份证
卡证 builtin-eK6p0vOB1AZmpGhLi9 孟加拉身份证
卡证 builtin-5DgJZFnVtvqKdKy2rW 马来西亚身份证
卡证 builtin-zZPeRQYVJ6JUQR6Ce4 文莱身份证
卡证 builtin-2t7zclgvWLt4OzmuRh 印度身份证
卡证 builtin-KMw0wDDdzSTs62jD6v 南非身份证
卡证 builtin-inpf3JKw4iBGRg6o1K 埃塞俄比亚身份证
卡证 builtin-Kc19djI2nepOIrFrjy 肯尼亚身份证
卡证 builtin-RpAJLFfches2ML9fH9 阿根廷身份证
卡证 builtin-rZugtolMwF7J6nkux6 哥伦比亚身份证
卡证 builtin-TrAXBLVnyyKJQdar1e 秘鲁身份证
卡证 builtin-EJdRAGeuyPLAG6qv8I 厄瓜多尔身份证

# 5.2 各能力对应识别返回结果说明

# 图片质量检测 builtin-ySmthSJqzQ3bN0Z9Y0

字段名 类型 中文说明 示例
quality Integer 图片质量:1=关键视觉信息清晰可辨,0=关键视觉信息模糊不清、难以辨认或无法可靠识别 1
issues String 质量问题枚举:1=模糊或分辨率低或失焦,2=眩光,3=太暗,4=太亮,5=其他质量问题 ["1","3"]

# 图片PS检测 builtin-lcDhAaeQMJcOandoBP

字段名 类型 中文说明 示例
is_tampered Boolean 布尔值为真时表示存在篡改,否则表示未检测到篡改痕迹 false
tampered_positions Array 篡改位置:每个元素代表文档中一个被篡改的矩形区域,八个数字分别对应四角坐标——左上角、右上角、右下角、左下角;一个文档中可能存在多个被篡改区域 [366,404,409,404,409,431,366,431]

# 简版通用水电煤燃气账单 builtin-0nZ0bZ09s9HqfjckoF

字段名 类型 中文说明 示例
names string 姓名 SANDRA REGINA SALES
addrs string 地址 RUA RAY PALMEIRAS 88.57480-000
isTampered boolean 是否存在篡改 false

# 详版燃气账单 builtin-8qUxGuXkYTm4U3lLxb

字段名 类型 中文说明 示例
BillingCompany String 开具账单的燃气公司 Petrotrade
CustomerName String 客户全名 Jack
Address String 街道地址 29.88 Road
CurrentReading Number 当前的计量表读数 234
PreviousReading Number 上次的计量表读数 188
Consumption Number 燃气消耗量 46
NumberOFBills Number 包含的账单数量 2
AmountDue Number 总应缴金额 230
AmountInWords String 大写金额 Two hundred and thirty
BillingPeriodFrom String 计费周期的开始日期(年-月) 2025-01
BillingPeriodTo String 计费周期的结束日期(年-月) 2025-02
BillId String 账单参考编号 123456789012
IssueDate String 发行日期(年-月-日 时:分:秒) 2025-02-03 11:22:33
CollectorName String 收银员/收款人姓名 Mary
City String 客户所在城市 Beijing
Branch String 分支机构/中心 Chaoyang
PaymentType String 支付方式(现金、信用卡等) cash

# 详版电费单 builtin-u6OXNzMM68cMyqfCH8

字段名 类型 中文说明 示例
BillingCompany String 开具账单的电力公司的名称 Horth Catto Electricity Distribution Co.
TaxNumber String 公司的税务登记号码 156-176-210
BillID String 账单的参考编号或唯一标识符 b9036650afbf4ft
PaymentCode String 用于付款的代码 01344519012500
IssueDate String 账单开具日期(年-月-日) 2025-04-13
City String 客户所在城市 Beijing
Area String 行政区域/管理单位 Chaoyang
CustomerName String 账单接收者的全名 Jack
Address String 客户的街道地址 24.56 Road
Description String 如公寓、楼层或位置描述等的附加地址详情 Floor 3
MeterNumber String 电表的唯一编号 6154005
CurrentReading Number 电表的当前读数 254717
PreviousReading Number 电表的上一次读数 413
Consumption Number 该时间段内的用电量 254304
NumberOfBills Number 此账单中包含的账单数量 1
AmountDue Number 当前计费周期内的应缴金额 580
TotalPaid Number 客户支付的总金额 580
AmountInWords String 客服支付的金额(大写) Five hundred and eighty

# M-PESA流水证明 builtin-yQU9ZpfsRuFeNUy4aw

字段名 类型 中文说明 示例
detailed_statement String 交易明细列表
balance String 当前交易完成后的账户余额 94.66
completion_time String 交易完成时间 2025-10-11 14:39:57
details String 交易详情/交易说明 Customer Transfer of Funds Charge
paid_in String 转入金额(收入金额) 2000.00
receipt_no String 凭证号/流水号/交易编号 TJBFM75IEL
transaction_status String 交易状态 Completed
withdrawn String 转出金额(支出金额) -7.00
m_pesa_statement String M-PESA账单信息
customer_name String 客户姓名 Jack
email_address String 邮箱地址 credit@flsshpesa.k0
mobile_number String 手机号码 0727610015
request_date String 账单申请/导出日期 13 Oct 2025
statement_period String 账单统计周期 13 Sep 2025 - 13 Oct 2025
summary String 汇总统计(按照交易类型分类)
paid_in String 总收入金额 0.00
paid_out String 总支出金额 4,891.00
transaction_type String 交易类型 SEND MONEY:

# 银行流水识别 builtin-Dr2fttpaJzyOg2oGYZ

字段名 类型 中文说明 示例
title String 文件标题 ##bank tracsaction
key_extraction Array 文件关键信息提取
accountName String 账户名 Jack
accountNumber String 账户号码 1234567890123
currency String 币种 CNY
regionCode String 钞汇标识 Local currency
dateRange String 起止日期 20230903-20240902
electronicSerialNumber String 电子流水号 12345678901234
details Array 具体交易细节信息
User String 对手信息 Mary
Date String 交易日期 20230906
Amount String 交易金额
details.Transaction id String 交易ID
Status String 交易状态
Notes String 交易备注
summary Array 交易汇总信息
summary.Transaction time String 交易时间
Income String 交易收入
Expense String 交易支出
balance String 交易盈余
QRIncome String 交易中的二维码收入
sensitive String 敏感风险项
top10 Array 排名前十的交易
Counterparty String 交易对手
Amount String 交易金额
recordCount String 交易记录数
Type String 交易类型
resources String 源文件的url地址

# 非标交易流水识别 builtin-ftEObTXXN9m03VXmwZ

说明:返回数据为对象(Object)结构,包含流水头部信息和交易明细。其中 transactions 为交易明细数组,每个元素代表一条交易记录;otherHeadings 为除常规头部字段外的扩展字段对象,不同流水文档返回的字段可能不同。

字段名 类型 中文说明 示例
title string 银行流水标题或账户页面标题。若不存在或无法识别,返回空字符串。 easypaisa Account
accountHolder string 账户持有人姓名。若不存在或无法识别,返回空字符串。 SAMI ULLAH
accountNo string 银行账号或账户号码。若不存在或无法识别,返回空字符串。 03430281764
cardNo string 银行卡号。若不存在或无法识别,返回空字符串。 6222021234567890
institution string 银行、电子钱包或其他金融机构名称。若不存在或无法识别,返回空字符串。 easypaisa
currency string 账户币种。可返回币种名称或 ISO 4217 币种代码;若不存在或无法识别,返回空字符串。 PKR
iban string 国际银行账户号码(IBAN)。若不存在或无法识别,返回空字符串。 PK88TMFB0000000063778775
fromDate string 流水起始日期,格式为 YYYY-MM-DD。若不存在或无法识别,返回空字符串。 2026-05-01
toDate string 流水结束日期,格式为 YYYY-MM-DD。若不存在或无法识别,返回空字符串。 2026-05-31
otherHeadings object 其他顶部信息,以动态键值对形式返回。对象中的每一项均为一组“字段名称: 字段值”;字段名称和数量不固定。若无其他顶部信息,返回空对象 {} {"Contact Number":"03430281764","Email":"samiullahb726@gmail.com"}
+动态键值对 string key 为银行流水中识别到的原始字段名称,value 为对应字段内容。不同银行、国家和流水模板可能返回不同的 key "Contact Number": "03430281764"
transactions array 交易明细数组。每个元素代表一条交易记录;若未识别到有效交易记录,返回空数组 [] [{"time":"2026-05-24 18:31:00","amount":"-300.00","party":"MUHAMMAD ANAS TAQI","balance":"112520.83"}]
+time string 交易时间。支持格式:YYYY-MM-DDYYYY-MM-DD HH:MM:SSHH:MM:SS。若时间不可见或无法识别,返回空字符串。 2026-05-24 18:31:00
+amount string 交易金额。不包含币种、货币符号和千分位分隔符。收入使用正号 +,支出使用负号 -。若金额不可见或无法识别,返回空字符串。 -300.00
+party string 交易对手方名称。仅提取明确可见的个人姓名、商户名、公司名等;若无明确交易对手方或无法判断,返回空字符串。 MUHAMMAD ANAS TAQI
+balance string 交易后余额。不包含币种、货币符号和千分位分隔符。若交易后余额不可见或无法识别,返回空字符串。 112520.83

# 企业注册登记证明 builtin-siyppaCoUSYW1VImX9

字段名 类型 中文说明 示例
registry Array 公司注册信息
companyName String 公司名称 PRO ELECT SARL
legalForm String 企业法律形式/公司类型 SARL
commercialRegNumber String 商业注册号/工商登记号 A123456789
nationalId String 国家税号/统一企业识别号 M05231912784120L
registryOffice String 注册登记机关 CDI DOUALA 5
registrationDate String 企业注册成立日期 2018-02-01
companyDuration String 公司营业期限 2050-02-01
contracts String 合同信息列表
partners String 股东/合伙人信息列表
authorizedSigners String 授权签字人/法定签字人信息列表
capital String 注册资本信息列表
mainAddress Array 公司地址
street String 街道地址 Happy Road
city String 城市 Beijing
governorate String 省/州/行政区 Chaoyang
country String 国家 China
ownedByCompany String 该地址房产是否由公司拥有 true
branches String 分支机构/子公司列表
activities Array 经营范围/业务活动列表
importExportRestricted String 是否存在进出口限制 true
issuedOffice String 签发机构/出具机关 CDI DOUALA 5
issueDate String 文件签发日期/有效截止日期 2025-12-31
taxCardInfo Array 税务卡片信息
country String 所属国家 China
governmentDepartment String 所属政府部门 Ministère des Finances
taxAuthority String 税务主管机关 Direction Générale des Impôts
companyName String 公司名称 PRO ELECT SARL
legalRepresentative String 法定代表人 Jack
companyType String 公司类型/企业性质 Sole-proprietorship enterprise
industry String 所属行业
address String 公司注册地址/经营地址
provinceOrRegion String 省份/地区
taxCardNumber String 税卡号/税务登记号 A123456789
commercialRegistrationDate String 工商注册日期 2020-02-01
taxRegistrationDate String 税务登记日期 2020-02-02
phoneNumbers String 联系电话列表 12345678901
lostANdFoundContact String 遗失联系信息/拾获联系号码 12345678901
cardUsageNote String 卡片用途说明/使用备注 仅用于XTransfer企业认证使用
foundInstructions String 拾获后的处理说明

# 购物小票识别 builtin-AsGltresBLOGouN1Pr

字段名 类型 中文说明 示例
sn String 店铺名称 ATK免税店
sid String 店铺编号 店0001
rid String 小票编号 0001
dt String 开票日期时间 2025-11-20 21:00
cid String 操作员编号 0001
cn String 操作员姓名 张三
it String 商品列表
code String 商品编码 1234567890
name String 商品名 サラサクリップ 20色セット
qty String 商品数量 1
pri String 商品单价 1,000
amt String 商品行金额 1,000
taxFlag String 是否轻减税,免税标记
tax String 税信息
rate String 税率 0.08
base String 免税,应税对象金额 6,800
tax String 税额 546
rem String 备注说明 注)※印は軽減税率適用商品
tq String 合计商品数量 7
ta String 合计金额 9,137
cur String 币种 JPY

# 发票识别 builtin-FgYvNQQFGQ3o7qBVOe

字段名 类型 中文说明 示例
invoiceNumber String 发票编号 04
invoiceDate String 发票日期 2025-03-21
seller String 卖方信息
name String 卖方姓名 JACK
address String 卖方地址 210 Farm Hattingh
buyer String 买方信息
name String 买方姓名 BEN
address String 买方地址 22 Ferguson Road
lineitems Array 商品明细列表
description String 商品描述 Foundation
quantity Number 商品数量 1
unitPrice Number 商品单价 100
totalPrice Number 商品总价 1000
tax Number 税额 50
totalAmount Number 发票总金额 3000

# 通用护照识别 builtin-GehZrc2wddibKXSAWb

字段名 类型 中文说明 示例
countryCode String 国家代码 CHN
passportNumber String 护照号码 E40898665
fullNameLocal String 全名,使用当地语言表示 张三
fullNameLatin String 全名,使用英语拉丁字符表示 ZHANG SAN
surname String ZHANG
givenName String SAN
middleName String 中间名 null
nationality String 国籍 CHINESE
dateOfBirth String 出生日期,格式为YYYY-MM-DD 2009-09-09
sex String 性别,F=女,M=男 F
placeOfBirth String 出生地 河北
placeOfIssue String 发证地 河北
dateOfIssue String 发证日期,格式为YYYY-MM-DD 2015-01-06
dateOfExpiry String 失效日期,格式为YYYY-MM-DD 2020-01-05
issuingAuthority String 发证机关 公安部出入境管理局
isPP Boolean 是否为护照,true=是,false=否 true

# 全球卡证出生日期与年龄解析 builtin-reKEg1UVsgE5yGtNO7

字段名 类型 中文说明 示例
dob string 持证人的出生日期,统一转换为公历(Gregorian Calendar)格式,输出 YYYY-MM-DD;无法识别时返回空字符串 "" 1976-06-18
adult boolean 是否已满 18 周岁;true 表示已成年,false 表示未成年;当 dob 为空时返回空字符串 "" true
age object 持证人的年龄,按完整经过的年、月计算;不足一个完整月不进位;当 dob 为空时返回空字符串 "" {"years":50,"months":1}
+years integer 已完整经过的年龄(年) 50
+months integer 已完整经过的月份(0~11),不足一个完整月不进位 1

# 中国台湾物权证 builtin-nGd1eMoYS2mBKgjYQ6

字段名 类型 中文说明 示例
certNo String 建筑物所有权的证书编号 108北士字第000001号
owner String 建筑物所有者的姓名(个人或组织) 张三
ownerId String 所有者的统一识别号码(类似于个人身份证号码或公司注册号码) 1234567890123
lot String 建筑物登记的地块编号或地籍位置 朝阳区0001
houseNo String 建筑物的房屋编号 幸福路123号三楼
floor String 建筑物的楼层或级别描述 三层

# 中国台湾不动产权证 builtin-ZXELuKZ7SXPGWmixZE

字段名 类型 中文说明 示例
name String 证书持有者的中文姓名 张三
id String 证书持有者的台湾身份证号码 A123456789
bDateTw String 以台湾地区格式表示的出生日期,格式为”民國月**日“ 民國70年05月12日
bDate String 以年-月-日格式表示的出生日期 1981-05-12
certNo String 证书编号 (xx)XX字第XXX號
issDateTw String 以台湾地区格式表示的证书颁发日期,格式为”民國月**日“ 民國70年05月12日
issDate String 以年-月-日格式表示的证书颁发日期 1981-05-12
issuer String 颁发机构的名称或地点 高雄市政府地政局

# 中国台湾身份证 builtin-SrFi52OPlDGKSQmjvZ

字段名 类型 中文说明 示例
name string 持证人姓名 林小明
dateOfBirth string 持证人出生日期,按证件原始格式返回 民國72年1月1日
gender string 持证人性别
issueDate string 证件发证日期,按证件原始格式返回;如包含发证地区、换发/补发等备注信息,一并返回 民國107年10月15日(北市)换發
nationalID string 台湾身份证统一编号 A123456789

# 中国台湾居民居住在 builtin-UqDwMvWDRD05zCm0BG

字段名 类型 中文说明 示例
name string 持证人姓名 张三
gender string 持证人性别,男/女
dob string 持证人出生日期,格式为YYYY-MM-DD 2000-01-01
address string 持证人居住地址 北京市朝阳区xxx号
no string 台湾居民居住证号码 12345678901234567
issAuthority string 证件签发机关 北京市朝阳区和平分局
issDate string 证件签发日期,格式为YYYY-MM-DD 2019-01-01
expiryDate string 证件有效期截止日期,格式为YYYY-MM-DD 2024-01-01
renew string 换发次数或续签次数 01
permitNo string 台湾居民来往大陆通行证号码 12345678

# 菲律宾多证件识别 builtin-laCUS0pQTRGOrEas0l

卡证类型 字段 类型 含义 输出示例
全部 cardType string 卡证类型,UMID、SSS_ID、PASSPORT、DRIVER_LICENSE、NATIONAL_ID、POSTAL_ID、PRC_ID UMID
UMID crn string 卡号 / CRN 0020-1215160-9
UMID surname string SANTOS
UMID givenName string JOSE
UMID middleName string 中间名 CRUZ
UMID fullName string 全名组合(given + middle + surname) JOSE CRUZ SANTOS
UMID gender string 性别 M / F
UMID dob string 出生日期,YYYY-MM-DD 1960-01-28
UMID address string 全部地址,多行合并 28 PAYAPA ST BAGONG DIWA STO CRISTOBAL CALOOCAN CITY METRO MANILA PHILIPPINES 1800
SSS_ID no string 社会保险号 02-2102579-6
SSS_ID name string 全名 MARVIN GALANG PANGAN
SSS_ID dob string 出生日期,YYYY-MM-DD 1984-12-13
PASSPORT country string ISO 国家代码 PHL
PASSPORT type string 护照类型 P
PASSPORT no string 护照号 P1234567
PASSPORT nameLocal object 本地姓名结构 {full, surname, givenName, middleName}
PASSPORT nameLatin object 拉丁姓名结构 {full, surname, givenName, middleName}
PASSPORT nationality string 国籍 Filipino
PASSPORT dob string 出生日期,YYYY-MM-DD 1990-01-01
PASSPORT sex string 性别 M / F
PASSPORT pob string 出生地 QUEZON CITY
PASSPORT issPlace string 签发地 null
PASSPORT issDate string 签发日期,YYYY-MM-DD 2015-06-01
PASSPORT expiryDate string 到期日期,YYYY-MM-DD 2025-06-01
PASSPORT issAuthority string 签发机关 DFA Manila
PASSPORT MRZ object 机读区 {line1, line2}
DriverLicense name string 全名 DELA CRUZ, JUAN PEDRO GARCIA
DriverLicense nationality string 国籍 PHL
DriverLicense gender string 性别 M / F
DriverLicense dob string 出生日期,YYYY-MM-DD 1995-08-15
DriverLicense weight string 体重(kg) 60
DriverLicense height string 身高(m) 1.70
DriverLicense address string 地址,多行合并 1123 YOUR ADDRESS, MANILA, 1008 METRO MANILA, PHILIPPINES
DriverLicense no string 驾照号 D23-52 867231
DriverLicense expiryDate string 到期日期,YYYY-MM-DD 2024-04-11
DriverLicense agencyCode string 发证机构代码 D24
DriverLicense bloodType string 血型 A+
DriverLicense eyesColor string 眼睛颜色 BLACK
DriverLicense restrictions string 驾照限制 1,2
DriverLicense conditions string 驾照条件 NONE
NATIONAL_ID no string PhilSys 卡号 / 主 ID 1234-5678912-3
NATIONAL_ID givenName string JUAN
NATIONAL_ID middleName string 中间名 MARTINEZ
NATIONAL_ID surname string DELA CRUZ
NATIONAL_ID gender string 性别 M / F
NATIONAL_ID dob string 出生日期,YYYY-MM-DD 1990-01-01
NATIONAL_ID pob string 出生地 QUEZON CITY
NATIONAL_ID blood string 血型 O
NATIONAL_ID marital string 婚姻状况 Single
NATIONAL_ID address string 地址,多行合并 01 SAMPALOC, MANILA CITY, METRO MANILA
NATIONAL_ID issDate string 签发日期,YYYY-MM-DD 2015-06-01
PostalID no string 邮政身份证号 / PRN CA314000001-B
PostalID name string 全名 MA. JOSEFINA M. DELA CRUZ
PostalID address string 地址,多行合并 662 Mendoza St. Lolomboy Bocaue Bulacan 3018
PostalID dob string 出生日期,YYYY-MM-DD 1958-02-24
PostalID nationality string 国籍 Filipino
PostalID expiryDate string 到期日期,YYYY-MM-DD 2017-11-04
PostalID issOffice string 发证邮局 MNL CPO
PRCID lastName string DUMANDAN
PRCID firstName string GLORIO JR
PRCID middleName string 中间名 ORTEGA
PRCID regNo string 注册号 003978
PRCID regDate string 注册日期,YYYY-MM-DD 2008-10-30
PRCID expiryDate string 到期日期,YYYY-MM-DD 2011-05-16
PRCID profession string 职业 / 专业 CRIMINOLOGIST
TIN_ID name string 持证人姓名 DELA CRUZ, JUAN
TIN_ID tin string 纳税人识别号 123-456-789-000
TIN_ID address string 持证人地址 28 Payapa St. Bagong Diwa Sto. Cristobal, Caloocan City
TIN_ID dob string 出生日期,YYYY-MM-DD 1994-09-04
TIN_ID issDate string 签发日期,YYYY-MM-DD 2017-10-02
VOTER_ID vin string 选民识别号 VIN 7404-2491C-D2843TPR10000
VOTER_ID name string 持证人姓名 REYES TEODORO PANGLINAN
VOTER_ID dob string 出生日期,YYYY-MM-DD 1943-04-26
VOTER_ID status string 婚姻状态,按卡面原文返回 Married
VOTER_ID citizenship string 公民身份/国籍 Filipino
VOTER_ID address string 持证人地址 B17 L21 VILLANOVA SUBD., NAGKAISANG NAYON
VOTER_ID precinct string 投票区编号 / Precinct No. 2491C
VOTER_ID issDate string 签发或登记日期,YYYY-MM-DD 2023-11-29
OWWA_ID name string 持证人姓名 REYES TEODORO PANGLINAN
OWWA_ID dob string 出生日期,YYYY-MM-DD 1982-10-05
OWWA_ID gender string 性别,M/F M
OWWA_ID address string 持证人地址 B17 L21 VILLANOVA SUBD., NAGKAISANG NAYON
OWWA_ID no string OFW ID / OFW e-CARD 号码 OWWA000001
OWWA_ID issDate string 签发日期,YYYY-MM-DD 1982-10-05
GSIS_ID name string 持证人姓名 JUANA DE LA CRUZ
GSIS_ID no string GSIS号码 123456789012
GSIS_ID bankNo string 银行卡号 4000 0076 1978 0014
GSIS_ID dob string 出生日期,YYYY-MM-DD 1960-01-28
GSIS_ID gender string 性别,M/F F
GSIS_ID address string 持证人地址 28 Payapa St. Bagong Diwa Sto. Cristobal Caloocan City, MM 1800
GSIS_ID validThru string 有效期;精确到月返回 YYYY-MM,精确到日返回 YYYY-MM-DD 2008-09
PHILHEALTH_ID name string 持证人姓名 DARIO, ANDINO BALANA
PHILHEALTH_ID no string PhilHealth卡号 / PIN 02-050329439-8
PHILHEALTH_ID dob string 出生日期,YYYY-MM-DD 1987-04-05
PHILHEALTH_ID gender string 性别,M/F M
PHILHEALTH_ID address string 持证人地址 29 B5 SITIO MA CORAZON PH2 SANTA CRUZ ANTIPOLO CITY, RIZAL - 1870
PAGIBIG_ID name string 持证人姓名 JUANA A. DELA CRUZ
PAGIBIG_ID no string Pag-IBIG MID号码 / 会员编号 1023-4567-8090

# 巴基斯坦多卡证识别 builtin-5Rfhqo1A3MGROHUNJJ

支持识别5类巴基斯坦身份证件:cnic(Computerized National Identity Card)、snic(Smart National Identity Card)、nicop(National Identity Card for Overseas Pakistanis)、poc(Pakistan Origin Card)、arc(Alien Registration Card),上述类型之外的识别为other(其他)。

字段名 类型 中文说明 所属卡证 示例
no string 持证人身份证号码 5类卡证正面 34101-5378249-5
name string 持证人姓名(英文) 5类卡证正面 Adeel Sajjad
fatherName string 持证人父亲姓名(英文);如无可为空字符串 5类卡证正面 Sajjad Ahmed
husbandName string 持证人配偶姓名(英文,仅适用于已婚女性);如无可为空字符串 5类卡证正面
gender string 持证人性别;可选值 M(男性)、F(女性)、X(第三性别) 5类卡证正面 M
dob string 持证人出生日期,格式 YYYY-MM-DD 5类卡证正面 2000-08-12
countryOfStay string 持证人当前居住国家 5类卡证正面 Pakistan
issDate string 证件签发日期,格式 YYYY-MM-DD niocp的背面,其余4类卡证的正面 2024-11-17
expiryDate string 证件有效期截止日期,格式 YYYY-MM-DD niocp的背面,其余4类卡证的正面 2034-11-17
presentAddress string 当前居住地,多为乌尔都语 5类卡证的背面
permanentAddress string 永久居住地,多为乌尔多语 5类卡证的背面
type string "cnic":Computerized National Identity Card,巴基斯坦境内公民身份证。正面无芯片,卡面内容通常为乌尔都语。 "snic":Smart National Identity Card,带芯片的巴基斯坦智能公民身份证。正面包含芯片。"nicop":National Identity Card for Overseas Pakistanis,海外巴基斯坦公民身份证。 "poc":Pakistan Origin Card,面向具有巴基斯坦血统或联系的外国公民。"arc":Alien Registration Card,面向在巴基斯坦登记的外国人。 "other":上述之外的其他类型。 --- snic

# 东帝汶多卡证识别 builtin-6UOFfK0g1gMvgCHx19

卡证类型 字段名 类型 中文说明 示例
CITIZEN_CARD cardType string 证件类型,固定返回 CITIZEN_CARD CITIZEN_CARD
CITIZEN_CARD no string 公民身份证号码,通常对应 No BI / Card NoNo BICard No 0600506125463002
CITIZEN_CARD name string 持证人姓名,通常对应 Nome do Titular / Full Name MARIA DA SILVA
CITIZEN_CARD marital string 婚姻状态,通常对应 Estado Civil / Marital Status CASADO
CITIZEN_CARD gender string 持证人性别;可选值 MF F
CITIZEN_CARD height string 身高,不包含单位 155
CITIZEN_CARD dob string 出生日期,格式为 YYYY-MM-DD 1990-05-12
CITIZEN_CARD pob string 出生地,通常对应 Naturalidade / Place of Birth DILI
CITIZEN_CARD nationality string 国籍,通常对应 Nacionalidade / Nationality TIMORENSE
CITIZEN_CARD fatherName string 父亲姓名;如父母姓名未明确区分,通常取父母信息中的第一行 JOSE DA SILVA
CITIZEN_CARD motherName string 母亲姓名;如父母姓名未明确区分,通常取父母信息中的第二行 ANA MARIA
CITIZEN_CARD address string 居住地址,通常对应 Residência / Address DILI, TIMOR-LESTE
CITIZEN_CARD issDate string 签发日期,格式为 YYYY-MM-DD 2020-01-15
CITIZEN_CARD expiryDate string 有效期截止日期,格式为 YYYY-MM-DD 2030-01-15
DRIVING_LICENSE cardType string 证件类型,固定返回 DRIVING_LICENSE DRIVING_LICENSE
DRIVING_LICENSE no string 驾驶证号码或卡号,通常对应 No CC 等字段 03029/DNTT/C/IV/09
DRIVING_LICENSE name string 持证人姓名 JOAO PEREIRA
DRIVING_LICENSE nationality string 证件中显示的国籍或出生地信息,按原文返回 TIMOR-LESTE
DRIVING_LICENSE dob string 出生日期,格式为 YYYY-MM-DD 1988-03-20
DRIVING_LICENSE address string 持证人地址,通常对应 Morada DILI
DRIVING_LICENSE gender string 持证人性别;可选值 MF M
DRIVING_LICENSE eyes string 眼睛颜色,通常对应 Olhos Castanhos
DRIVING_LICENSE height string 身高,按证件显示返回,不包含单位 180
DRIVING_LICENSE blood string 血型,通常对应 G. Sanguineo O
DRIVING_LICENSE issDate string 签发日期,格式为 YYYY-MM-DD 2016-04-10
DRIVING_LICENSE expiryDate string 有效期截止日期,格式为 YYYY-MM-DD 2026-04-10
PASSPORT cardType string 证件类型,固定返回 PASSPORT PASSPORT
PASSPORT country string 签发国家 ISO 3166-1 alpha-3 代码 TLS
PASSPORT Type string 护照类型,如普通护照、外交护照等类型代码 P
PASSPORT no string 护照号码 P1234567
PASSPORT surname string 持证人姓氏/家族名,按护照可见内容返回 GUTERRES
PASSPORT givenName string 持证人名字,按护照可见内容返回 JOSE
PASSPORT nationality string 国籍,按护照可见内容返回 TIMORESE
PASSPORT dob string 出生日期,格式为 YYYY-MM-DD 1990-06-15
PASSPORT sex string 持证人性别;可选值 MF M
PASSPORT pob string/null 出生地,按护照可见内容返回;如未显示可返回 null DILI
PASSPORT issDate string 签发日期,格式为 YYYY-MM-DD 2021-05-01
PASSPORT expiryDate string 有效期截止日期,格式为 YYYY-MM-DD 2031-05-01
PASSPORT issAuthority string/null 签发机关;如未显示可返回 null MINISTRY OF JUSTICE
PASSPORT line1 string MRZ 第一行,通常以 P< 开头 P<TLSGUTERRES<<JOSE<<<<<<<<<<<<<<<<
PASSPORT line2 string MRZ 第二行,包含护照号、国籍、出生日期、有效期等信息 P1234567<TLS9006151M3105012<<<<<<<<
VOTER_CARD cardType string 证件类型,固定返回 VOTER_CARD VOTER_CARD
VOTER_CARD cardNo string 选民卡号码,通常对应 Nú CartãoNo. CartãoNú. Kartaun 等字段 123456
VOTER_CARD regNo string 登记号或文件编号,通常对应 Nú De InscriçãoNo. DocNú. Dok 等字段 987654321
VOTER_CARD name string 持证人姓名,通常对应 Nome / Naran JOAO DA COSTA
VOTER_CARD dob string 出生日期,格式为 YYYY-MM-DD 1995-08-10
VOTER_CARD pob string 出生地,通常对应 Naturalidade / Moris Fatin BAUCAU
VOTER_CARD municipality string 市/区,通常对应 Município DILI
VOTER_CARD post string 行政区,通常对应 Posto Adm. DOM ALEIXO
VOTER_CARD suco string Suku/Suco,村镇或基层区域名称 COMORO
VOTER_CARD aldeia string Aldeia,基层居住区域名称 30 DE AGOSTO

# 尼日利亚多卡证 builtin-cimngo8Kfy06XJ6Wk8

卡证类型 字段名 类型 中文说明 示例
ID_CARD cardType string 证件类型枚举值 ID_CARD
ID_CARD no string 身份证号码,11 位以上数字,可包含空格 12345678901
ID_CARD surame string 姓氏 / 家族名 ADELEYE
ID_CARD givenName string 名 / 主要名 JOHN
ID_CARD middleName string 中间名,按证件显示,不可推断 MICHAEL
ID_CARD dob string 出生日期,格式 YYYY-MM-DD 1990-05-12
ID_CARD issDate string 证件签发日期,格式 YYYY-MM-DD 2015-10-08
ID_CARD expiryDate string 证件有效期,格式 YYYY-MMYYYY-MM 2029-05
PASSPORT cardType string 证件类型枚举值 PASSPORT
PASSPORT country string ISO 3166-1 alpha-3 国家代码 NGA
PASSPORT Type string 护照类型,如 P/D P
PASSPORT no string 护照号码 A1234567
PASSPORT +nameLocal object/null 本地语言姓名结构 { "full":"...", "surname":"...", "givenName":"..."}
PASSPORT +nameLocal.full string 本地语言完整姓名 አልሃምዱ ዲነካ ሬዳ
PASSPORT +nameLocal.surname string 本地语言姓氏 / 家族名 ዲነካ
PASSPORT +nameLocal.givenName string 本地语言名 / 给定名 አልሃምዱ
PASSPORT +nameLocal.middleName string 本地语言中间名(如果有) ሬዳ
PASSPORT +nameLatin object 拉丁字母姓名结构 { "full":"...", "surname":"...", "givenName":"..."}
PASSPORT +nameLatin.full string 拉丁字母完整姓名 ALHAMDU DINEKA REDA
PASSPORT +nameLatin.surname string 拉丁字母姓氏 / 家族名 DINEKA
PASSPORT +nameLatin.givenName string 拉丁字母名 / 给定名 ALHAMDU
PASSPORT +nameLatin.middleName string 拉丁字母中间名(如果有) REDA
PASSPORT nationality string 国籍 NIGERIA
PASSPORT dob string 出生日期,格式 YYYY-MM-DD 1990-05-12
PASSPORT gender string 性别,M/F M
PASSPORT pob string/null 出生地 LAGOS
PASSPORT issPlace string/null 签发地 null
PASSPORT issDate string 签发日期,YYYY-MM-DD 2015-10-08
PASSPORT expiryDate string 有效期,YYYY-MM-DD 2025-10-08
PASSPORT issAuthority string/null 签发机关 MINISTRY OF FOREIGN AFFAIRS
PASSPORT MRZ object 机器可读区信息 { "line1":"...", "line2":"..." }
PASSPORT +MRZ.line1 string MRZ 第一行,通常以 P< 开头 P<NLSNAME<<GIVEN<<<<<<<<<<<<
PASSPORT +MRZ.line2 string MRZ 第二行,包含护照号、国籍、出生日期、有效期等信息 P1234567<NGA9006151M2510082<<<<<<<<<<
DRIVING_LICENSE cardType string 证件类型枚举值 DRIVING_LICENSE
DRIVING_LICENSE no string 驾驶证号码 03029/DNTT/C/IV/09
DRIVING_LICENSE class string 驾驶证类别 C
DRIVING_LICENSE name string 持证人姓名 JOHN MICHAEL ADELEYE
DRIVING_LICENSE gender string 性别,M/F M
DRIVING_LICENSE address string/null 居住地址 null
DRIVING_LICENSE dob string 出生日期,YYYY-MM-DD 1990-05-12
DRIVING_LICENSE issDate string 签发日期,YYYY-MM-DD 2015-10-08
DRIVING_LICENSE expiryDate string 有效期,YYYY-MM-DD 2025-10-08
VOTER_CARD cardType string 证件类型枚举值 VOTER_CARD
VOTER_CARD vin string 选民编号(Voter Identification Number) 123456
VOTER_CARD code string 投票站编号 987
VOTER_CARD delim string 包含州/地方政府/选区的字符串 LAGOS IKEJA WARD1
VOTER_CARD name string 持证人姓名 JOHN MICHAEL ADELEYE
VOTER_CARD gender string 性别,M/F M
VOTER_CARD dob string 出生日期,YYYY-MM-DD 1990-05-12
VOTER_CARD occupa string 职业 Teacher
VOTER_CARD address string/null 居住地址 null

# 巴西多卡证 builtin-VaJK7W9EV8wIOcV2pe

支持识别巴西常见身份类证件,返回cardType,包括:

  • ID:巴西身份证(RG / CIN)
  • DriverLicense:巴西驾驶证(CNH / CNH-e)
  • Passport:巴西护照
  • CPFCard:巴西 CPF 卡
卡证类型/cardType 字段名 类型 中文说明 示例
ID name string 持证人姓名,通常对应 NOMENOME / NAME BERNARDO TZ
ID socialName string 社会姓名,仅当证件存在 NOME SOCIAL / SOCIAL NAME 字段时返回 MARIA SILVA
ID no string 身份证号码(RG号码),通常对应 REGISTRO GERALRGNº RG 4019865-7
ID cpf string CPF个人税号,通常对应 CPFNúmero CPFCPF / Personal Number 131.478.554-06
ID dob string 出生日期,格式为 YYYY-MM-DD,通常对应 DATA DE NASCIMENTODATE OF BIRTH 1985-05-15
ID gender string 性别,可选值 MF M
ID nationality string 国籍,通常对应 NACIONALIDADENATIONALITY BRASILEIRO
ID pob string 出生地,通常对应 NATURALIDADEPLACE OF BIRTH SAO PAULO - SP
ID fatherName string 父亲姓名,通常取 FILIAÇÃO / FILIATION 下第一行 JOSE DA SILVA
ID motherName string 母亲姓名,通常取 FILIAÇÃO / FILIATION 下第二行 MARIA DOS SANTOS
ID issDate string 签发日期,格式为 YYYY-MM-DD,通常对应 DATA DE EXPEDIÇÃODATA DE EMISSÃO 2022-02-19
ID issuer string 签发机构,通常对应 ÓRGÃO EXPEDIDORCARD ISSUER SSP-SP
ID poi string 签发地点,通常对应 LOCAL DE EXPEDIÇÃOLOCAL DE EMISSÃOPLACE OF ISSUE SAO PAULO
ID expiryDate string 有效期;日期转换为 YYYY-MM-DD,非日期内容保持原文 INDETERMINADA
DriverLicense name string 持证人姓名,通常对应 NOMENOME E SOBRENOME LUCIANO REIS DE OLIVEIRA
DriverLicense licenseNo string 驾驶证注册号码,通常对应 Nº REGISTRO5 Nº REGISTRO 04054230998
DriverLicense cpf string CPF号码,通常对应 CPF4e CPF 034.343.099-18
DriverLicense idNo string 身份证号码(RG),通常对应组合字段 DOC. IDENTIDADE / ÓRG. EMISSOR / UF 中第一部分 246969374
DriverLicense idIssuer string 身份证签发机构,通常对应 DOC. IDENTIDADE / ÓRG. EMISSOR / UF 中第二部分 SSP
DriverLicense idState string 身份证签发州,通常对应 DOC. IDENTIDADE / ÓRG. EMISSOR / UF 中第三部分 SP
DriverLicense dob string 出生日期,通常对应 DATA LOCAL E UF DE NASCIMENTO,格式 YYYY-MM-DD 1955-08-14
DriverLicense pob string 出生地点,通常位于 DATA LOCAL E UF DE NASCIMENTO 日期之后 MATUTINA/MG
DriverLicense fatherName string 父亲姓名,通常取 FILIAÇÃO 下第一行 JOSE FELICIO DO AMARAL
DriverLicense motherName string 母亲姓名,通常取 FILIAÇÃO 下第二行 IZOLINA MARIA DE JESUS
DriverLicense category string 当前驾驶类别,通常对应 CAT. HAB. D
DriverLicense nationality string 国籍,通常对应 NACIONALIDADE BRASILEIRO
DriverLicense categoryDetails array 各驾驶类别及对应有效期,仅返回有明确有效期的类别;相同有效期的类别合并 [{"category":["B","C"],"expiryDate":"2029-09-06"}]
DriverLicense licenseDate string 首次取得驾驶资格日期,通常对应 1ª HABILITAÇÃO 2001-01-19
DriverLicense issDate string 当前驾驶证签发日期,通常对应 4a DATA EMISSÃODATA EMISSÃO 2022-11-07
DriverLicense expiryDate string 驾驶证有效期,通常对应 4b VALIDADE 2032-07-16
DriverLicense poi string 签发地点,通常对应底部 LOCAL 字段 OSVALDO CRUZ SP
DriverLicense observations string 备注或限制信息,通常对应 OBSERVAÇÕES EAR
Passport country string 签发国家 ISO 3166-1 alpha-3 国家代码 BRA
Passport type string 护照类型代码 P
Passport no string 护照号码,通常对应 PASSAPORTE NºPASSPORT No. AA000681
Passport surname string 姓氏/家族名,通常对应 SOBRENOMESURNAME COSTA
Passport givenName string 名字,通常对应 NOMEGIVEN NAME CARLOS
Passport nationality string 国籍,通常对应 NACIONALIDADENATIONALITY BRASILEIRO(A)
Passport dob string 出生日期,格式为 YYYY-MM-DD 2001-03-16
Passport gender string 性别,可选值 MF M
Passport pob string 出生地,通常对应 NATURALIDADEPLACE OF BIRTH BRASILIA/DF
Passport idNo string 个人身份号码,通常对应 IDENTIDADE Nº / PERSONAL No.,保持证件原始格式 12.345.678-9
Passport fatherName string 父亲姓名,通常取 FILIAÇÃO / FILIATION 第一行 MARCOS JOSE DOS SANTOS
Passport motherName string 母亲姓名,通常取 FILIAÇÃO / FILIATION 第二行 AMANDA FARIAS DOS SANTOS
Passport issDate string 签发日期,格式为 YYYY-MM-DD 2012-07-06
Passport expiryDate string 有效期截止日期,格式为 YYYY-MM-DD 2022-07-06
Passport issAuthority string 签发机构,通常对应 AUTORIDADE / AUTHORITY SR/PF/RJ
Passport line1 string MRZ第一行,通常以 P< 开头 P<BRA...
Passport line2 string MRZ第二行 AA000681BRA...
CPFCard no string CPF号码,通常对应 Número de InscriçãoCPF;保持证件显示格式 123.456.789-09
CPFCard name string 持证人姓名,通常对应 NomeNome da Pessoa JOAO SILVA
CPFCard dob string 出生日期,通常对应 Nascimento,格式为 YYYY-MM-DD 1990-05-12
CPFCard issDate string 签发日期,通常对应 Emissão;格式为 YYYY-MM 2020-08

# 越南身份证 builtin-86og0wZ7HLhSXlYG7p

字段名 类型 中文说明 示例
idNo string 越南身份证号码/公民身份号码 001096840920
name string 持证人姓名,按证件显示内容返回 NÔNG VAN HIEU
gender string 持证人性别,M=男,F=女 M
bDate string 持证人出生日期,格式为 YYYY-MM-DD 1996-05-16
nationality string 持证人国籍,按证件显示内容返回 Việt Nam
origin string 原籍/出生地/籍贯信息(Quê quán),按证件显示内容返回 Chi Dông, Mê Linh, Hà Noi
res string 常住地址/居住地址(Nơi thường trú),按证件显示内容返回 To 2, Chi Dong, Me Linh, Hà Noi
expiryDate string/null 证件有效期截止日期,格式为 YYYY-MM-DD;无有效期时返回 null 2028-05-16
issueDate string/null 证件签发日期,格式为 YYYY-MM-DD 2021-06-21
issuer string/null 证件签发机关 CUC TRUONG CUC CANH SAT QUAN LY HANH CHINH VE TRAT TU XA HOI
isID boolean 是否为越南身份证:true=是,false=否。支持越南不同版本身份证,包括 Căn Cước Công Dân(CCCD,公民身份证)及 Chứng Minh Nhân Dân / Giấy Chứng Minh Nhân Dân(CMND,旧版人民身份证);护照、驾驶证及其他非身份证件返回 false。 true
qrData object/null 身份证二维码解析结果;二维码不存在或无法解析时返回 null -
+idNo string 二维码中解析出的身份证号码 001096840920
+oldIdNo string/null 二维码中解析出的旧身份证号码;不存在时返回 null 012345678
+name string 二维码中解析出的姓名 NÔNG VAN HIEU
+bDate string 二维码中解析出的出生日期,格式为 YYYY-MM-DD 1996-05-16
+gender string 二维码中解析出的性别(原始值) Nam / Nữ
+res string 二维码中解析出的居住地址 To 2, Chi Dong, Me Linh, Hà Noi
+issueDate string 二维码中解析出的签发日期,格式为 YYYY-MM-DD 2021-06-21

# 泰国身份证 builtin-i88oDw1H2dbkpAXzJ3

字段名 类型 中文说明 示例
name string 持证人英文完整姓名,由英文名与英文姓组合返回 Mr. Napat Thaikiaue
firstName string 持证人英文名,包含卡面印刷的敬语/称谓,如 Mr.、Mrs.、Miss. Mr. Napat
lastName string 持证人英文姓氏 Thaikiaue
thaiName string 持证人泰文完整姓名,按卡面原文返回 นาย ณภัทร ไทยเกื้อ
thaiFirstName string 持证人泰文名,包含卡面印刷的泰文敬语/称谓 นาย ณภัทร
thaiLastName string 持证人泰文姓氏 ไทยเกื้อ
idNo string 泰国国民身份证号码,13位数字,返回时去除数字间空格 1100200280560
laserId string 身份证背面的 Laser ID(Laser Code),保留连字符;未提供背面或无法识别时返回空 AB1-2345678-90
bDate string 出生日期,统一返回 YYYY-MM-DD 格式 1992-11-23
gender string 性别,标准化返回 M 或 F M
address string 地址,按卡面泰文地址完整返回 96 ถ.รังสิต-ปทุมธานี 27 ต.ประชาธิปัตย์ อ.ธัญบุรี จ.ปทุมธานี
issueDate string 身份证签发日期,统一返回 YYYY-MM-DD 格式 2020-11-22
expiryDate string 身份证有效期,统一返回 YYYY-MM-DD 格式;永久有效返回 LIFELONG 2024-06-26 / LIFELONG

# 柬埔寨身份证 builtin-IPC3Peq8NRXRxr4ZbE

字段名 类型 中文说明 示例
no string 柬埔寨身份证号码 190457306
fullNameLatin string 持证人拉丁字母姓名 VANN VIREAK
fullNameLocal string 持证人本地语言姓名 វ៉ាន់ វីរៈ
gender string 持证人性别;可选值 MF M
dob string 持证人出生日期,格式为 YYYY-MM-DD 1967-11-13
height string 持证人身高,按证件显示内容返回 ១៦១ ស.ម
issDate string 证件签发日期,格式为 YYYY-MM-DD 2015-10-08
expiryDate string 证件有效期截止日期,格式为 YYYY-MM-DD 2035-07-07
nationality string 持证人国籍或国家代码 KHM
pob string 持证人出生地,按证件显示内容返回 ឃុំអន្លង់វិល ស្រុកសង្កែ បាត់ដំបង
address string 持证人住址,按证件显示内容返回 ភូមិត្រពេច ស្រុកថ្មពួក បន្ទាយមានជ័យ
identifyingMarks string 持证人身体识别特征或显著标记 ប្រជ្រុយចំ ០.៥សម មុខលើគល់ភ្នែកស្តាំ
mrzLine1 string MRZ 第一行内容 IDKHM1904573061<<<<<<<<<<<<<<<<
mrzLine2 string MRZ 第二行内容 6711137M3507072KHM<<<<<<<<<<<<4
mrzLine3 string MRZ 第三行内容 VANN<<VIREAK<<<<<<<<<<<<<<<<<<<

# 孟加拉身份证 builtin-eK6p0vOB1AZmpGhLi9

字段名 类型 中文说明 示例
idNo string 孟加拉身份证号码 ID No. 8704637043
name string 持证人英文姓名 MD. SHIPON MIA
localName string 持证人本地语言姓名 মোঃ শিপন মিয়া
fatherName string 持证人父亲姓名,通常为本地语言 মোঃ সাজু মিয়া
motherName string 持证人母亲姓名,通常为本地语言 মোছাঃ শিল্পী বেগম
dob string 持证人出生日期,格式为 YYYY-MM-DD 1998-09-25
gender string 持证人性别;F/M,如证件未显示或无法识别,为空字符串 F
blood string 持证人血型;如证件未显示或无法识别,为空字符串 A+
address string 持证人地址;如证件未显示或无法识别,为空字符串
pob string 持证人出生地;如证件未显示或无法识别,为空字符串 JHALOKATI
issDate string 证件签发日期,格式为 YYYY-MM-DD;如证件未显示或无法识别,可为空字符串 2026-11-03
expiryDate string 证件有效期截止日期,格式为 YYYY-MM-DD;如证件未显示或无法识别,为空字符串 2036-11-03

# 马来西亚身份证 builtin-5DgJZFnVtvqKdKy2rW

字段名 类型 中文说明 示例
no string 身份证号码(MyKad 编号) 460619-12-5087
dob string 出生日期(YYYY-MM-DD) 1946-06-19
name string 姓名 ABD RAUF BIN HAMSAH
gender string 性别;M 表示男性,F 表示女性 M
address string 地址 P O BOX 42, 89007 KENINGAU, SABAH
nationality string 国籍/公民身份 WARGANEGARA
religion string 宗教 ISLAM
issuer string 签发机关 KETUA PENGARAH PENDAFTARAN NEGARA

# 文莱身份证 builtin-zZPeRQYVJ6JUQR6Ce4

字段名 类型 中文说明 示例
type string 居留/公民身份;CITIZEN 表示公民,PERMANENT 表示永久居民,TEMPORARY 表示临时居民 CITIZEN
no string 身份证号码(个人身份证号) 65-453556
name string 姓名 SHUFTI PRO
dob string 出生日期(YYYY-MM-DD) 1990-06-09
pob string 出生地或出生国家 BRUNEI DARUSSALAM
gender string 性别;M 表示男性,F 表示女性 M
address string 居住地址 09-XXX

# 印度身份证 builtin-2t7zclgvWLt4OzmuRh

字段名 类型 中文说明 示例
no string 身份证号码(Aadhaar Number) 342506531151
name string 姓名 Sid malhorta
birth string 出生日期(YYYY-MM-DD) 1980-03-16
gender string 性别;M 表示男性,F 表示女性 F

# 南非身份证 builtin-KMw0wDDdzSTs62jD6v

字段名 类型 中文说明 示例
surname string 持证人姓氏 / 家族名 IMMELMAN
names string 持证人名 / 给定名 WAYNE LEE
gender string 持证人性别,可选值 MF M
nationality string 持证人国籍,按证件上显示 RSA
no string 南非身份证号码,通常为 13 位数字字符串 8510315120089
dob string 出生日期,格式 YYYY-MM-DD 1985-10-31
pob string 出生地 / Country of Birth,按证件显示 RSA
status string 公民身份或居留状态 CITIZEN
issDate string 证件签发日期,格式为 YYYY-MM-DD 2015-10-08

# 埃塞俄比亚身份证 builtin-inpf3JKw4iBGRg6o1K

字段名 类型 中文说明 示例
nameLocal string 持证人本地语言姓名,通常为阿姆哈拉语姓名 አልሃምዱ ዲነካ ሬዳ
nameLatin string 持证人拉丁字母姓名,按证件可见内容返回 Alhamdu Dineka Reda
gender string 持证人性别;可选值 MF M
dobLocal string 持证人出生日期,埃塞俄比亚本地历法日期,格式为 YYYY-MM-DD 1996-01-01
dob string 持证人出生日期,国际通用公历日期,格式为 YYYY-MM-DD 2003-09-12
nationalityLocal string 持证人本地语言国籍或公民身份信息 ኢትዮጵያዊ
nationality string 持证人英文国籍或公民身份信息 Ethiopian
fan string FAN 编号,按证件显示的可见号码返回;不包含 FAN 标签,未显示时可为空字符串 4195302617209485
fin string FIN 编号,按证件显示的可见号码返回;不包含 FIN 标签,未显示时可为空字符串 581260930236
fcn string FCN 编号,按证件显示的可见号码返回;不包含 FCN 标签,未显示时可为空字符串 2132836096158706
issDateLocal string 证件签发日期,埃塞俄比亚本地历法日期,格式为 YYYY-MM-DD 2017-07-15
issDate string 证件签发日期,国际通用公历日期,格式为 YYYY-MM-DD 2025-03-24
expiryDateLocal string 证件有效期截止日期,埃塞俄比亚本地历法日期,格式为 YYYY-MM-DD 2025-08-13
expiryDate string 证件有效期截止日期,国际通用公历日期,格式为 YYYY-MM-DD 2033-04-21
printDate string 证件打印日期,国际通用公历日期,格式为 YYYY-MM-DD 2024-06-13
phone string 持证人联系电话,通常位于证件背面,按可见内容返回 0912662007
addressLocal string 持证人本地语言地址,通常位于证件背面;仅提取阿姆哈拉语地址行,多行地址用英文逗号合并 ኦሮሚያ, ቢሾፍቱ, ኦዳ ናቤ
address string 持证人英文或拉丁字符地址,通常位于证件背面;仅提取英文/拉丁字符地址行,多行地址用英文逗号合并 Oromia, Bishoftu City Administration - Dukam, Oda Nabe

# 肯尼亚身份证 builtin-Kc19djI2nepOIrFrjy

字段名 类型 中文说明 示例
serialNo string 证件序列号(SERIAL NUMBER),通常位于卡片左侧或顶部 A1234567
no string 身份证号 / HUDUMA / MAISHA 编号 12345678
name string 持证人全名(FULL NAME / FULL NAMES) JOHN MWANGI KAMAU
dob string 出生日期,统一格式 YYYY-MM-DD 1990-08-30
gender string 性别,M=男 / F=女 M
nationality string 国籍 KEN
pob string 出生地(PLACE/DISTRICT OF BIRTH) NAIROBI
issPlace string 签发地点(PLACE OF ISSUE) NAIROBI
issDate string 签发日期,YYYY-MM-DD 2020-12-04
expiryDate string 有效期/到期日期,YYYY-MM-DD 2033-12-04

# 阿根廷身份证 builtin-RpAJLFfches2ML9fH9

字段名 类型 中文说明 所在卡面 示例
idNo string 身份证号 正面 99999999
surName string 姓氏 / 家族名 正面 GARCIA
givenName string 名 / 多个 正面 JUAN CARLOS
gender string 性别 正面 M / F
nationality string 国籍 正面 ARGENTINA
renew string 版本标识 正面 A / B
dob string 出生日期 正面 2016-02-22
issDate string 签发日期 正面 2023-04-20
expiryDate string 有效期 正面 2038-10-30
address string 地址(原文) 背面 GENERAL RODRIGUEZ PAZ 83
pob string 出生地 背面 CHILE
cuil string 税号/劳工号 背面 27-99999999-0

# 哥伦比亚身份证 builtin-rZugtolMwF7J6nkux6

字段名 类型 中文说明 示例
ID object 卡面视觉区域识别结果 -
+no string 国家身份证号码(NUIP) 1.000.000.000
+sur string 姓氏(Apellidos) CASAS RUBIANO
+given string 名字(Nombres) DANIELA
+dob string 出生日期 2000-12-11
+sex string 性别 M / F
+pob string 出生地点(Lugar de nacimiento) CARTAGENA (BOLIVAR)
+poi string 签发地点(Lugar de expedición) CARTAGENA
+iss string 签发日期 2019-01-16
+exp string 有效期 2033-02-26
MRZ object 机器可读区识别结果 -
+docno string MRZ 第一行中的证件编号 000000012
+dob string MRZ 出生日期 1988-08-21
+sex string MRZ 性别 M / F
+exp string MRZ 有效期 2031-01-30
+fname string MRZ 解析后的完整姓名 CASAS RUBIANO DANIELA

# 秘鲁身份证 builtin-TrAXBLVnyyKJQdar1e

字段名 类型 中文说明 示例
front object 身份证正面识别结果 -
+dni string 身份证号码(DNI) 47973966
+surname1 string 第一姓(父姓) SANCHEZ
+surname2 string 第二姓(母姓) HUAPAYA
+names string 名字,可包含多个名字 ESTEPHANI ELIZABETH
+birthDate string 出生日期 1993-08-27
+birthUbigeo string 出生地 UBIGEO 行政区代码 140133
+sex string 性别,F=女,M=男 F
+marital string 婚姻状态 S
+regDate string 登记日期 2010-11-10
+issueDate string 证件签发日期 2023-02-23
+expDate string 证件有效期 2031-02-23
back object 身份证背面识别结果 -
+dept string 省级行政区(Department) LIMA
+prov string 省(Province) LIMA
+dist string 区/县(District) SANTIAGO DE SURCO
+addr string 居住地址 MZ.C LT.18 ASOC. DE VIV SAN JOSE
+level string 登记级别代码 140130
+organ string 器官捐献意愿 SI / NO
+voteGrp string 投票组代码 257530

# 厄瓜多尔身份证 builtin-EJdRAGeuyPLAG6qv8I

字段名 类型 所在卡面 中文说明 示例
name string 正面 持证人完整姓名(姓氏+名字) VIZUETE VIZUETE ANGEL HERIBER
surname string 正面 姓氏 VIZUETE VIZUETE
givenName string 正面 名字 ANGEL HERIBER
no string 正面 证件号码(Document Number) 091787689-8
nui string 正面 唯一身份识别号码(NUI) 1719142905
nationality string 正面 国籍 ECUATORIANA
gender string 正面 性别 M / F
dob string 正面 出生日期(YYYY-MM-DD) 1993-01-19
pob string 正面 出生地点 CHIMBORAZO RIOBAMBA
expiryDate string 正面 证件有效期(YYYY-MM-DD) 2031-12-08
issueDate string 反面 证件签发日期(YYYY-MM-DD) 2021-12-08
issuePlace string 反面 证件签发地点 RIOBAMBA
father string 反面 父亲姓名 VIZUETE VIDAL
mother string 反面 母亲姓名 VIZUETE MARIA
spouse string 反面 配偶或同居伴侣姓名 LARA RUIZ MARIA MAGDALENA
maritalStatus string 反面 婚姻状况 CASADO
isCard string - 是否为厄瓜多尔身份证 true/false
mrz object MRZ 机器可读区(MRZ)识别结果 -
+no string MRZ MRZ 证件号码 017836244
+nationality string MRZ MRZ 国籍(三字母代码) ECU
+dob string MRZ MRZ 出生日期(YYYY-MM-DD) 1993-01-19
+gender string MRZ MRZ 性别 M / F
+expiryDate string MRZ MRZ 有效期(YYYY-MM-DD) 2031-12-08
+surname string MRZ MRZ 姓氏 VIZUETE VIZUETE
+givenName string MRZ MRZ 名字 ANGEL HERIBER

# 6 异常说明

HTTP状态代码 错误信息 说明
400 BAD_ARGUMENTS: 某个参数解析出错(比如BAD_ARGUMENTS:app_id,传入不存在的app_id)
400 FILE_PARSE_FAILED: 文件下载阶段失败
400 FILE_EXTRACT_FAILED: 文件识别阶段失败
400 INVALID_INPUTS_PARAM: 自定义字段inputs格式不合法
400 FILE_TOO_LARGE 文件超过大小限制,建议9M以内
400 FILE_UNSUPPORTED_FORMAT 不支持的文件格式
400 TOO_MANY_FILES 入参中传入了多余实际支持的文件数量
400 MISSING_ARGUMENTS: 缺少某个必选参数
400 KEY_NOT_FOUND encryption_type开启加密,但未配置加密公钥和解密私钥
403 AUTHENTICATION_ERROR api_key和api_secret不匹配
403 AUTHORIZATION_ERROR: api_key被停用、调用次数超限、没有调用此API的权限,或者没有以当前方式调用此API的权限。比如:"DENIED." : api_key无权限或被停用,"Limit reached." : 这个api_key对当前API的调用量达到上限。
403 CONCURRENCY_LIMIT_EXCEEDED 并发数超过限制
403 AUTHENTICATION_ERROR: NO_APP_PERMISSION 无app调用权限
404 API_NOT_FOUND 所调用的API接口地址不存在
500 INTERNAL_ERROR 服务器内部错误,当此类错误发生时请再次请求,如果持续出现此类错误,请及时联系 FaceID 客服或商务

# 7 计费逻辑说明

HTTP状态码status_code=200 且返回数据中pages不为空时计费/扣除试用次数。

# 8 响应示例

# 8.1 正确请求返回示例(通用护照识别)

text
{
"request_id": "a2c5e8b1-4f7d-4a9e-8c3b-6e1d5f8a2b3c",
"time_used": 932,
"pages": 1,
"result": {
  "outputs": {
    "text": {
      "countryCode": "CHN",
      "passportNumber": "E40898665",
      "fullNameLocal": "张三",
      "fullNameLatin": "ZHANG SAN",
      "surname": "ZHANG",
      "givenName": "SAN",
      "middleName": null,
      "nationality": "CHINESE",
      "dateOfBirth": "2009-09-09",
      "sex": "F",
      "placeOfBirth": "河北",
      "placeOfIssue": "河北",
      "dateOfIssue": "2015-01-06",
      "dateOfExpiry": "2020-01-05",
      "issuingAuthority": "公安部出入境管理局",
      "isPP": true
    }
  }
}
}

# 8.2 错误相应返回示例

text
{
"request_id": "d5f8b2e4-7c1a-4d3f-9b6e-2a4c8d3b5e6f",
"time_used": 150,
"error_message": "FILE_TOO_LARGE"
}