接入文档
OCR识别(海外版)
海外智慧文档OCR
海外智慧文档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 调用此API客户的签名,具体的签名产生方式请查阅”鉴权说明“文档
必选 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 识别能力说明
1 builtin-7qguFU6sa5DmgHm08q 支持对人像照片中头部佩戴及是否出现多人进行识别
2 builtin-0nZ0bZ09s9HqfjckoF 从水电煤燃气账单中识别姓名及地址信息
3 builtin-RyLF2nZWGT2rMdU8S9 对人像照片从室内室外环境、人口统计学、行为外观等维度进行识别
4 builtin-ySmthSJqzQ3bN0Z9Y0 图片质量分析检测
5 builtin-AsGltresBLOGouN1Pr 购物小票进行识别
6 builtin-FgYvNQQFGQ3o7qBVOe 发票文件进行识别
7 builtin-Dr2fttpaJzyOg2oGYZ 银行流水文件进行识别
8 builtin-siyppaCoUSYW1VImX9 企业注册证明文件的识别
9 builtin-8qUxGuXkYTm4U3lLxb 燃气账单识别
10 builtin-u6OXNzMM68cMyqfCH8 电费单识别
11 builtin-nGd1eMoYS2mBKgjYQ6 台湾物权证明识别
12 builtin-ZXELuKZ7SXPGWmixZE 台湾不动产权证识别
13 builtin-lcDhAaeQMJcOandoBP 图片PS检测
14 builtin-yQU9ZpfsRuFeNUy4aw M-PESA出具的流程证明文件识别
15 builtin-GehZrc2wddibKXSAWb 护照识别及判断照片中是否为护照
16 builtin-laCUS0pQTRGOrEas0l 菲律宾7类卡证的识别,UMID=统一多用途身份证,SSS_ID=社会保障系统编号,PASSPORT=护照,DRIVER_LICENSE=驾驶证,NATIONAL_ID=国家身份证,POSTAL_ID=邮政身份证,PRC_ID=专业注册委员会身份证
17 builtin-NHq96vD0BhlbEivKLr 菲律宾人像照片特征识别
18 builtin-MBl1quBumLoVtYUZVq 墨西哥人像照片特征识别
19 builtin-SrFi52OPlDGKSQmjvZ 台湾身份证识别
20 builtin-UqDwMvWDRD05zCm0BG 台湾居民居住证
21 builtin-5Rfhqo1A3MGROHUNJJ 巴基斯坦身份证
22 builtin-eK6p0vOB1AZmpGhLi9 孟加拉身份证
23 builtin-6UOFfK0g1gMvgCHx19 东帝汶证件(身份证/护照/驾驶证/选民证)
24 builtin-86og0wZ7HLhSXlYG7p 越南身份证
25 builtin-IPC3Peq8NRXRxr4ZbE 柬埔寨身份证
26 builtin-cimngo8Kfy06XJ6Wk8 尼日利亚证件(身份证/护照/驾驶证/选民证)
27 builtin-KMw0wDDdzSTs62jD6v 南非身份证
28 builtin-inpf3JKw4iBGRg6o1K 埃塞俄比亚身份证
29 builtin-YgWCVSXqZ0qj8I31Rg 自拍照合规检测
30 builtin-Li4ZATHXbMQQa66gPi 海外巴基斯坦公民身份证,NICOP(National Identity Card for Overseas Pakistanis)

# 5.2 证件类型识别返回对照(text)

# 5.2.1 builtin-7qguFU6sa5DmgHm08q

字段名 类型 中文说明 示例
other_person Integer 第三人/其他人员出现:0=空/不适用,1=无,2=有 1
header_wear Integer 头部佩戴:0=空/不适用,1=无,2=安全帽,3=骑行头盔,4=头巾,5=浴帽,6=棒球帽,7=贝雷帽,8=礼帽,9=针织帽,10=草帽,11=医用绷带,12=其他物品 0

# 5.2.2 builtin-0nZ0bZ09s9HqfjckoF

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

# 5.2.3 builtin-RyLF2nZWGT2rMdU8S9

字段名 类型 中文说明 示例
scene_type Integer 场景类型:0=空/不适用,1=室内,2=室外 1
indoor_decoration_level Integer 装修程度:0=空/不适用,1=无装修,2=简易装修,3=一般装修,4=精致装修,5=无法判断 3
indoor_decoration_style Integer 装修风格:0=空/不适用,1=无装修,2=极简简陋,3=传统乡村民居,4=基础现代风,5=经济型简约风,6=中档现代风,7=工业风,8=北欧风,9=美式风格,10=轻奢风,11=豪华奢华风,12=混搭杂糅风 6
indoor_wall_type Integer 墙体类型:0=空/不适用,1=木板,2=木条,3=竹编墙,4=棕榈墙,5=混凝土,6=砖墙裸露,7=铁皮,8=PVC板墙,9=瓷砖,10=无,11=其他 9
indoor_roof_type Integer 屋顶类型:0=空/不适用,1=木板,2=竹编,3=石材,4=铁皮,5=水泥,6=波纹板,7=毛坯水泥,8=单色粉刷,9=装修吊顶,10=瓦片,11=茅草,12=无,13=其他 9
indoor_curtain Integer 窗帘:0=空/不适用,1=有,2=无 1
indoor_curtain_color Integer 窗帘颜色:0=空/不适用,1=白色,2=灰色,3=黑色,4=卡其,5=黄色,6=橙色,7=粉色,8=红色,9=蓝色,10=绿色,11=紫色,12=拼色,13=印花彩色,14=渐变色彩 2
indoor_curtain_type Integer 窗帘类型:0=空/不适用,1=简易布帘,2=纱帘,3=百叶帘,4=卷帘,5=罗马帘,6=垂直帘,7=竹帘,8=天棚帘,9=其他 1
indoor_cleanliness Integer 室内整洁度:0=空/不适用,1=整洁,2=一般,3=杂乱 2
indoor_clean_level Integer 室内干净度:0=空/不适用,1=干净,2=一般,3=脏污 2
indoor_clothes_storage Integer 衣服收纳:0=空/不适用,1=无衣物,2=随意堆放,3=随意悬挂,4=整齐收纳 4
indoor_item_storage Integer 物品收纳:0=空/不适用,1=整洁有序,2=轻度杂乱,3=重度凌乱,4=无物品 1
indoor_random_hanging_clothes Integer 随意悬挂衣服:0=空/不适用,1=是,2=否 2
indoor_cooling_appliance Integer 制冷家电:0=空/不适用,1=无,2=壁挂扇,3=落地扇,4=台扇,5=吊扇,6=壁挂空调,7=立式空调,8=中央空调,9=其他 6
indoor_power_socket Integer 电源插座:0=空/不适用,1=有,2=无 1
indoor_socket_type Integer 插座类型:0=空/不适用,1=嵌入式插座,2=明装插座,3=移动插排 1
indoor_room_count Integer 出现房间数:0=空/不适用,1=单间,2=多间,3=角落区域 1
indoor_room_type Integer 房间类型:0=空/不适用,1=卧室,2=客厅,3=厨房,4=卫生间,5=工人宿舍,6=杂货店,7=办公室,8=仓库,9=简易木棚,10=简易铁皮棚,11=病房,12=杂物间,13=商场内,14=工厂,15=其他 1
indoor_shop_type Integer 商店类型:0=空/不适用,1=厨房用品,2=小零食,3=生活用品,4=电器,5=洗漱用品,6=综合商品,7=其他 0
indoor_room_size Integer 房间大小:0=空/不适用,1=狭小,2=适中,3=宽敞,4=无法判断 2
indoor_furniture_level Integer 家具配置:0=空/不适用,1=无家具,2=廉价家具,3=中等家具,4=高档家具,5=无法判断 3
other_person Integer 第三人/其他人员出现:0=空/不适用,1=无,2=有 1
outdoor_scene_type Integer 室外类型:0=空/不适用,1=城市街道,2=城市广场,3=城市商场周边,4=城市小区,5=乡村街道,6=乡村庭院,7=乡村田间,8=露天加工厂,9=简易生产车间,10=车内,11=公园,12=其他 0
lighting Integer 光照度:0=空/不适用,1=明亮,2=正常,3=昏暗,4=黑暗 2
urban_rural_type Integer 城乡属性:0=空/不适用,1=大城市,2=小城市,3=县城,4=城郊,5=一般农村,6=贫困农村,7=山区,8=无法判断 1
gender Integer 性别:0=空/不适用,1=男,2=女,3=无法判断 1
age_range Integer 年龄区间:0=空/不适用,1=1-10岁,2=11-17岁,3=18-25岁,4=26-35岁,5=36-45岁,6=46-55岁,7=55岁以上 4
head_wear Integer 头部佩戴:0=空/不适用,1=无,2=安全帽,3=骑行头盔,4=头巾,5=浴帽,6=棒球帽,7=贝雷帽,8=礼帽,9=针织帽,10=草帽,11=医用绷带,12=其他物品 1
neck_wear Integer 颈部佩戴:0=空/不适用,1=无,2=项链,3=工牌,4=丝巾/围巾,5=颈托/医用绷带,6=耳机 1
ear_wear Integer 耳部佩戴:0=空/不适用,1=无,2=耳钉,3=耳环 1
glasses Integer 眼镜:0=空/不适用,1=无,2=透明眼镜,3=深色眼镜 2
face_appearance Integer 脸部容貌:0=空/不适用,1=正常,2=普通瑕疵,3=部分疤痕或创伤,4=大面积疤痕,5=毁容,6=畸形 1
facial_expression Integer 表情:0=空/不适用,1=正常,2=挤眉弄眼,3=扮鬼脸,4=怪笑,5=夸张表情 1
facial_decoration Integer 面部装饰:0=空/不适用,1=贴胶布,2=夸张涂抹,3=特殊符号,4=道具装饰,5=面膜,6=无,7=其他装饰 6
beard_exist Integer 是否有胡须:0=空/不适用,1=是,2=否 2
beard_type Integer 胡须类型:0=空/不适用,1=无胡须,2=胡茬,3=一字胡,4=八字胡,5=山羊胡,6=络腮胡,7=长款络腮胡,8=龙须胡,9=武士胡,10=其他胡须 1
face_shape Integer 脸型:0=空/不适用,1=圆形脸,2=椭圆形脸,3=方形脸,4=长形脸,5=心形脸,6=三角形脸,7=倒三角形脸,8=菱形脸,9=其他 2
eyebrow_type Integer 眉毛:0=空/不适用,1=一字眉,2=柳叶眉,3=野生眉,4=剑眉,5=弯眉,6=挑眉,7=平眉,8=断眉,9=无眉,10=稀疏眉,11=浓密眉,12=其他眉毛 11
eye_open_close Integer 眼睛开闭:0=空/不适用,1=睁大眼睛,2=自然睁眼,3=半睁眼,4=闭眼,5=眯眼 2
eye_gaze Integer 视线方向:0=空/不适用,1=斜视,2=正视,3=俯视,4=仰视 2
nose_type Integer 鼻子:0=空/不适用,1=高鼻梁,2=塌鼻梁,3=鹰钩鼻,4=朝天鼻,5=蒜头鼻,6=直鼻,7=翘鼻,8=宽鼻,9=窄鼻,10=驼峰鼻,11=其他鼻型 6
mouth_type Integer 嘴巴:0=空/不适用,1=M唇,2=花瓣唇,3=嘟嘟唇,4=薄唇,5=厚唇,6=樱桃唇,7=香肠唇,8=均衡唇,9=扬角唇,10=垂角唇,11=其他嘴型 8
face_fatness Integer 脸庞胖瘦:0=空/不适用,1=极瘦,2=较瘦,3=正常,4=较胖,5=极胖 3
face_attractiveness Integer 颜值:0=空/不适用,1=非常丑,2=较丑,3=一般,4=漂亮,5=非常漂亮 3
upper_cloth_type Integer 上衣款式:0=空/不适用,1=未穿上衣,2=内衣类,3=小吊带与背心,4=T恤,5=短袖衬衫,6=长袖衬衫,7=卫衣与连帽衫,8=针织上衣,9=夹克与外套,10=工服,11=制服,12=马甲,13=民族或特殊上衣,14=其他 4
upper_cloth_material Integer 上衣材质:0=空/不适用,1=棉麻,2=化纤,3=毛呢,4=丝绸,5=丝绒,6=针织,7=皮革,8=牛仔面料,9=功能面料,10=其他 1
uniform_type Integer 制服类型:0=空/不适用,1=保安,2=警察或军人,3=医护人员,4=外卖与快递,5=清洁与后勤,6=工程与工地,7=工厂与制造,8=餐饮服务,9=零售与商超,10=教育制服,11=交通运输,12=银行与政府机构制服,13=酒店服务,14=宗教制服,15=其他 0
clothing_scene_style Integer 场景衣着风格:0=空/不适用,1=休闲服,2=居家服,3=制服,4=正装,5=运动服,6=性感服装 1
clothing_fit Integer 衣着宽松度:0=空/不适用,1=宽松,2=正常,3=紧身 2
clothing_cleanliness Integer 衣着干净度:0=空/不适用,1=洁净,2=轻度污渍,3=重度脏污 1
clothing_color_mix Integer 配色:0=空/不适用,1=单色,2=双色,3=复杂多色 1
upper_body_exposure Integer 上身裸露程度:0=空/不适用,1=未裸露,2=小面积裸露,3=大面积裸露,4=全部裸露 1
tattoo_exists Integer 是否纹身:0=空/不适用,1=是,2=否 2
tattoo_area Integer 纹身面积:0=空/不适用,1=小,2=中,3=大 0
tattoo_type Integer 纹身类型:0=空/不适用,1=几何抽象,2=自然生物,3=文字符号,4=传统民俗,5=卡通潮流,6=暗黑神秘,7=其他 0
tattoo_position Integer 纹身位置:0=空/不适用,1=颈部,2=胳膊,3=胸部,4=背部,5=头部,6=面部,7=其他 0
hair_color Integer 头发颜色:0=空/不适用,1=白发,2=红色,3=绿色,4=紫色,5=灰色,6=黄色,7=黑色,8=金色,9=其他 7
hair_neatness Integer 头发整齐度:0=空/不适用,1=自然,2=凌乱,3=精致 1
hair_style_type Integer 发型类型:0=空/不适用,1=秃头/含地中海,2=超短发,3=短发,4=中短发/齐耳,5=中发/齐肩,6=中长发/及胸,7=长发/及腰,8=超长发/腰以下,9=特殊结构发型,10=其他 3
hair_volume Integer 发量:0=空/不适用,1=额头秃,2=全秃,3=稀疏,4=正常 4
wig_wear Integer 是否戴假发:0=空/不适用,1=是,2=否 2
hair_glossiness Integer 光泽度:0=空/不适用,1=高光泽,2=自然光泽,3=无光泽 2
body_shape Integer 身材:0=空/不适用,1=极瘦,2=较瘦,3=正常,4=较胖,5=极胖 3
holding_card Integer 是否手持卡证:0=空/不适用,1=是,2=否 2
communication_device Integer 通讯娱乐设备:0=空/不适用,1=无,2=固话,3=手机,4=头戴式耳机,5=入耳式无线耳机,6=入耳式有线耳机 3
pose_type Integer 姿势:0=空/不适用,1=站立,2=倚靠,3=坐立,4=蹲着,5=仰卧,6=侧卧 1

# 5.2.4 builtin-ySmthSJqzQ3bN0Z9Y0

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

# 5.2.5 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 商品列表
it.code String 商品编码 1234567890
it.name String 商品名 サラサクリップ 20色セット
it.qty String 商品数量 1
it.pri String 商品单价 1,000
it.amt String 商品行金额 1,000
it.taxFlag String 是否轻减税,免税标记
tax String 税信息
tax.rate String 税率 0.08
tax.base String 免税,应税对象金额 6,800
tax.tax String 税额 546
rem String 备注说明 注)※印は軽減税率適用商品
tq String 合计商品数量 7
ta String 合计金额 9,137
cur String 币种 JPY

# 5.2.6 builtin-FgYvNQQFGQ3o7qBVOe

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

# 5.2.7 builtin-Dr2fttpaJzyOg2oGYZ

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

# 5.2.8 builtin-siyppaCoUSYW1VImX9

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

# 5.2.9 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

# 5.2.10 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

# 5.2.11 builtin-nGd1eMoYS2mBKgjYQ6

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

# 5.2.12 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 颁发机构的名称或地点 高雄市政府地政局

# 5.2.13 builtin-lcDhAaeQMJcOandoBP

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

# 5.2.14 builtin-yQU9ZpfsRuFeNUy4aw

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

# 5.2.15 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

# 5.2.16 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

# 5.2.17 builtin-NHq96vD0BhlbEivKLr

参数名称 类型 描述
age_range Integer 年龄区间:0=空/不适用,1=1-10岁,2=11-17岁,3=18-25岁,4=26-35岁,5=36-45岁,6=46-55岁,7=55岁以上
eye_open_close Integer 眼睛睁开/闭合:0=空/不适用,1=睁大眼睛,2=自然睁眼,3=半睁眼,4=闭眼,5=眯眼
facial_decoration Integer 面部装饰:0=空/不适用,1=贴胶布,2=夸张涂抹,3=特殊符号,4=道具装饰,5=面膜,6=无,7=其他装饰
facial_expression Integer 面部表情:0=空/不适用,1=正常,2=挤眉弄眼,3=扮鬼脸,4=怪笑,5=夸张表情
gender Integer 性别:0=空/不适用,1=男,2=女,3=无法判断
head_wear Integer 头部穿戴:0=空/不适用,1=无安全帽,2=安全帽,3=骑行头盔,4=头巾,5=浴帽,6=棒球帽,7=贝雷帽,8=礼帽,9=针织帽,10=草帽,11=医用绷带,12=其他物品
mouth_type Integer 嘴巴类型:0=空/不适用,1=M唇,2=花瓣唇,3=嘟嘟唇,4=薄唇,5=厚唇,6=樱桃唇,7=香肠唇,8=均衡唇,9=扬角唇,10=垂角唇,11=其他嘴型
neck_wear Integer 颈部穿戴:0=空/不适用,1=无,2=项链,3=工牌,4=丝巾/围巾,5=颈托/医用绷带,6=耳机
nose_type Integer 鼻子类型:0=空/不适用,1=高鼻梁,2=塌鼻梁,3=鹰钩鼻,4=朝天鼻,5=蒜头鼻,6=直鼻,7=翘鼻,8=宽鼻,9=窄鼻,10=驼峰鼻,11=其他鼻型
wig_wear Integer 假发佩戴:0=空/不适用,1=是,2=否

# 5.2.18 builtin-MBl1quBumLoVtYUZVq

参数名称 类型 描述
age_range Integer 年龄区间:0=空/不适用,1=1-10岁,2=11-17岁,3=18-25岁,4=26-35岁,5=36-45岁,6=46-55岁,7=55岁以上
eye_open_close Integer 眼睛睁开/闭合:0=空/不适用,1=睁大眼睛,2=自然睁眼,3=半睁眼,4=闭眼,5=眯眼
facial_decoration Integer 面部装饰:0=空/不适用,1=贴胶布,2=夸张涂抹,3=特殊符号,4=道具装饰,5=面膜,6=无,7=其他装饰
facial_expression Integer 面部表情:0=空/不适用,1=正常,2=挤眉弄眼,3=扮鬼脸,4=怪笑,5=夸张表情
gender Integer 性别:0=空/不适用,1=男,2=女,3=无法判断
indoor_cleanliness Integer 室内整洁度:0=空/不适用,1=整洁,2=一般,3=杂乱
lighting Integer 光线:0=空/不适用,1=明亮,2=正常,3=昏暗,4=黑暗
pose_type Integer 姿态类型:0=空/不适用,1=站立,2=倚靠,3=坐立,4=蹲着,5=仰卧,6=侧卧
scene_type Integer 场景类型:0=空/不适用,1=室内,2=室外
tattoo_area Integer 纹身面积:0=空/不适用,1=小,2=中,3=大

# 5.2.19 builtin-SrFi52OPlDGKSQmjvZ

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

# 5.2.20 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

# 5.2.21 builtin-5Rfhqo1A3MGROHUNJJ

字段名 类型 中文说明 示例
no string 持证人身份证号码 34101-5378249-5
name string 持证人姓名(英文) Adeel Sajjad
fatherName string 持证人父亲姓名(英文);如无可为空字符串 Sajjad Ahmed
husbandName string 持证人配偶姓名(英文,仅适用于已婚女性);如无可为空字符串
gender string 持证人性别;可选值 M(男性)、F(女性) M
dob string 持证人出生日期,格式 YYYY-MM-DD 2000-08-12
countryOfStay string 持证人当前居住国家 Pakistan
issDate string 证件签发日期,格式 YYYY-MM-DD 2024-11-17
expiryDate string 证件有效期截止日期,格式 YYYY-MM-DD 2034-11-17

# 5.2.22 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

# 5.2.23 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

# 5.2.24 builtin-86og0wZ7HLhSXlYG7p

字段名 类型 中文说明 示例
idNo string 越南身份证号码或公民身份号码 035087008106
name string 持证人姓名,按证件显示内容返回 NGUYỄN ĐỨC TRỌNG
gender string 持证人性别;可选值 MF M
bDate string 持证人出生日期,格式为 YYYY-MM-DD 1987-01-22
nationality string 持证人国籍,按证件显示内容返回 Việt Nam
origin string 持证人原籍/出生地/籍贯信息,按证件显示内容返回 Ngọc Lũ, Bình Lục, Hà Nam
res string 持证人常住地址或居住地址,按证件显示内容返回 Thôn Đội 1
expiryDate string/null 证件有效期截止日期,格式为 YYYY-MM-DD 2027-01-22
issueDate string/null 证件签发日期,格式为 YYYY-MM-DD 2037-01-22
issuer string/null 证件签发机关

# 5.2.25 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<<<<<<<<<<<<<<<<<<<

# 5.2.26 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":"..."}
+nameLocal.full string 本地语言完整姓名 አልሃምዱ ዲነካ ሬዳ
+nameLocal.surname string 本地语言姓氏 / 家族名 ዲነካ
+nameLocal.givenName string 本地语言名 / 给定名 አልሃምዱ
+nameLocal.middleName string 本地语言中间名(如果有) ሬዳ
PASSPORT +nameLatin object 拉丁字母姓名结构 { "full":"...", "surname":"...", "givenName":"..."}
+nameLatin.full string 拉丁字母完整姓名 ALHAMDU DINEKA REDA
+nameLatin.surname string 拉丁字母姓氏 / 家族名 DINEKA
+nameLatin.givenName string 拉丁字母名 / 给定名 ALHAMDU
+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":"..." }
+MRZ.line1 string MRZ 第一行,通常以 P< 开头 P<NLSNAME<<GIVEN<<<<<<<<<<<<
+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

# 5.2.27 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

# 5.2.28 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

# 5.2.29 uiltin-YgWCVSXqZ0qj8I31Rg

字段名 类型 中文说明 示例
compliant boolean 整体合规性判断;true 表示照片符合全部拍摄要求,false 表示存在至少一项违规 false
violations array 违规项数组;当无违规时返回空数组 [] ["not_front","mouth_open"]
+not_front string 非正面人脸 not_front
+smiling string 非常明显的笑或大笑 smiling
+mouth_open string 张嘴,可以明显看到口腔内部、舌头或牙齿 mouth_open
+head_occluded string 头部被遮挡;宗教或医疗原因导致的头部遮挡可接受 head_occluded
+eyes_closed string 一只或两只眼睛闭着 eyes_closed
+red_eyes string 眼睛呈现非常明显的红色 red_eyes
+glasses_reflection string 佩戴普通眼镜,但镜片出现明显反光或阴影 glasses_reflection
+sunglasses string 佩戴深色太阳镜或墨镜 sunglasses
+multiple_faces string 图片中出现多张人脸或疑似人脸区域 multiple_faces

# 5.2.30 builtin-Li4ZATHXbMQQa66gPi

字段名 类型 中文说明 示例
no string 海外身份证号码 / NIC 号 313049-028789-5
name string 持证人全名(拉丁字母) Muhammad Amjad
fatherName string 持证人父亲姓名(拉丁字母) Muhammad Latif
gender string 性别 M / F / ""
dob string 出生日期 1996-01-01
countryOfStay string 居住国家 United Arab Emirates
presentAddress string 现居住地址,多行合并为一行 PO bandi mera, Bandi Mera, Teh and Distt Abbottabad, Pakistan
permanentAddress string 永久地址,多行合并为一行 PO bandi mera, Bandi Mera Teh and Distt Abbottabad, Pakistan
issDate string 签发日期 2014-08-07
expiryDate string 到期日期 2024-08-07
visaFreeEntry string 是否享有免签资格 ENTITLED / NOT_ENTITLED / UNKNOWN
mrzLine1 string MRZ 第一行 I<PAK13101500414798XPPN1<<<<
mrzLine2 string MRZ 第二行 950304M2408079PAK927FC5W<<<<3
mrzLine3 string MRZ 第三行 BASHIR<<WAQAR<<<<<<<<<<<

# 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不为空时计费/扣除试用次数。