接入文档
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({xxx})，inputs对应的格式需要是字符串。 |
| 必选 | app_id | String | 不同的识别能力对应不同的app_id，请参考下面的“数据字典” |
# 4 返回参数
接口调用成功时返回
| 字段 | 类型 | 参数说明 |
|---|---|---|
| request_id | String | 用于区分每一次请求的唯一的字符串。 |
| error_message | String | 错误信息。当请求失败时才会返回此字符串，具体返回内容见后续错误信息章节。否则此字段不存在。 |
| time_used | Int | 整个请求所花费的时间，单位为毫秒。 |
| result | Object | 不同的app_id/文档类型返回的结构不同，参考“数据字典” |
| - outputs | JSON | 文档识别结果JSON会封装在outputs中输出 |
| -- text | JSON | 这里包含对应appid返回的内容 |
| - pages | Int | 消耗的页数，页数*单价就是本次的实际价格，pages大于0/非空时计费 |
# 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-z7uwCkohkntS2KqUzY | 菲律宾多种证件的识别，识别4要素，证件号、姓名、出生日期、性别 |
# 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-z7uwCkohkntS2KqUzY
| 字段名 | 类型 | 中文说明 | 示例 |
|---|---|---|---|
| no | String | 身份证号 | P0000000A |
| name | String | 持证人的全名，全名的拼接顺序为：姓+中间名+名 | JACK |
| bDate | String | 出生日期，格式为YYYY-MM-DD | 1980-03-16 |
| gender | String | 性别，F=女，M=男 | F |
# 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 计费逻辑说明
status_code=200 且pages不为空时计费/扣除试用次数。