Access Documentation
OCR
Anydoc
Anydoc

# Smart Document Recognition (AnyDoc)

# 1 Description

This product provides a one-stop intelligent recognition service for non-document images and files, supporting structured information extraction and content parsing for various non-credential images, PDF files, and more. It covers many non-credential scenarios such as everyday receipts, bills, forms, contracts, and paper documents. The service offers highly compatible file and image parsing capabilities, including multi-page PDF recognition, image content extraction, layout restoration, and structured text output, meeting the full range of needs for automated data entry, information extraction, and document archiving of non-credential documents in overseas business.

# 2 Usage

# 2.1 Invoke URL

Singapore: https://api-sgp.yljz.com/finauth/v1/anydoc

# 2.2 Invoke Method

Request method: POST

Request format: form-data

Description: The client passes the encrypted signature sign generated from the apikey and secret, together with the file to be recognized. FinAuth returns the recognition result.

# 3 Request Parameters

Optional/Required Field Type Description
Required sign String For the signature generation rules, see Authentication.
Required sign_version String Signature algorithm version. Pass: hmac_sha1.
Required file File (Within 9 MB.) Supports images or PDF; the specific document types supported depend on each application. Supported image formats: .jpg, .jpeg, .png, gif, webp.
Optional inputs JSON String Depends on the parsed document type/app_id; pass when required. Format: 'inputs':json.dumps({"key":"xxx"}). The value for inputs must be a string.
Required app_id String Different recognition capabilities correspond to different app_ids. See the Data Dictionary below.

# 4 Response Parameters

Returned when the API call succeeds:

Field Type Description
request_id String A unique string that identifies each request.
error_message String Error message. Returned only when the request fails; see the Error Messages section for details. Otherwise this field is absent.
time_used Int The total time taken by the request, in milliseconds.
result Object The returned structure differs by app_id/document type. See the Data Dictionary.
+ pages Int The number of pages consumed. The actual price is pages × unit price. Billed when pages is greater than 0 / non-empty.
+ outputs JSON The document recognition result JSON is wrapped and output under outputs.
++ text JSON Contains the content returned for the corresponding app_id.

# 5 Data Dictionary

# 5.1 Smart Document Recognition Capabilities (app_id)

No. app_id Recognition Capability
1 builtin-7qguFU6sa5DmgHm08q Detects head-worn items in a portrait photo and whether multiple people appear.
2 builtin-0nZ0bZ09s9HqfjckoF Recognizes name and address from water, electricity, coal, or gas utility bills.
3 builtin-RyLF2nZWGT2rMdU8S9 Recognizes a portrait photo across dimensions such as indoor/outdoor environment, demographics, and behavior/appearance.
4 builtin-ySmthSJqzQ3bN0Z9Y0 Image quality analysis and detection.
5 builtin-AsGltresBLOGouN1Pr Shopping receipt recognition.
6 builtin-FgYvNQQFGQ3o7qBVOe Invoice file recognition.
7 builtin-Dr2fttpaJzyOg2oGYZ Bank statement file recognition.
8 builtin-siyppaCoUSYW1VImX9 Business registration certificate recognition.
9 builtin-8qUxGuXkYTm4U3lLxb Gas bill recognition.
10 builtin-u6OXNzMM68cMyqfCH8 Electricity bill recognition.
11 builtin-nGd1eMoYS2mBKgjYQ6 Taiwan property-right certificate recognition.
12 builtin-ZXELuKZ7SXPGWmixZE Taiwan real-estate title certificate recognition.
13 builtin-lcDhAaeQMJcOandoBP Image PS (Photoshop tampering) detection.
14 builtin-yQU9ZpfsRuFeNUy4aw Recognition of process/proof documents issued by M-PESA.
15 builtin-GehZrc2wddibKXSAWb Passport recognition and determining whether the photo is a passport.
16 builtin-laCUS0pQTRGOrEas0l Recognition of 13 Philippine card types: UMID = Unified Multi-Purpose ID, SSS_ID = Social Security System number, PASSPORT = passport, DRIVER_LICENSE = driver's license, NATIONAL_ID = national ID, POSTAL_ID = postal ID, PRC_ID = Professional Regulation Commission ID, TIN_ID = Taxpayer Identification Number ID, VOTER_ID = voter ID, OWWA_ID = Overseas Workers Welfare Administration ID, GSIS_ID = Government Service Insurance System ID, PHILHEALTH_ID = Philippine Health Insurance ID, PAGIBIG_ID = Pag-IBIG Fund member ID.
17 builtin-NHq96vD0BhlbEivKLr Philippine portrait photo feature recognition.
18 builtin-MBl1quBumLoVtYUZVq Mexican portrait photo feature recognition.
19 builtin-SrFi52OPlDGKSQmjvZ Taiwan ID card recognition.
20 builtin-UqDwMvWDRD05zCm0BG Taiwan resident residence permit.
21 builtin-5Rfhqo1A3MGROHUNJJ Pakistan ID card.
22 builtin-eK6p0vOB1AZmpGhLi9 Bangladesh ID card.
23 builtin-6UOFfK0g1gMvgCHx19 Timor-Leste documents (ID card / passport / driver's license / voter card).
24 builtin-86og0wZ7HLhSXlYG7p Vietnam ID card.
25 builtin-IPC3Peq8NRXRxr4ZbE Cambodia ID card.
26 builtin-cimngo8Kfy06XJ6Wk8 Nigeria documents (ID card / passport / driver's license / voter card).
27 builtin-KMw0wDDdzSTs62jD6v South Africa ID card.
28 builtin-inpf3JKw4iBGRg6o1K Ethiopia ID card.
29 builtin-YgWCVSXqZ0qj8I31Rg Selfie compliance detection.
30 builtin-Li4ZATHXbMQQa66gPi National Identity Card for Overseas Pakistanis (NICOP).
31 builtin-Kc19djI2nepOIrFrjy Kenya ID card.
32 builtin-RpAJLFfches2ML9fH9 Argentina ID card.
33 builtin-ftEObTXXN9m03VXmwZ Non-standard transaction/transfer screenshot recognition.
34 builtin-i88oDw1H2dbkpAXzJ3 Thailand ID card.
35 builtin-rZugtolMwF7J6nkux6 Colombia ID card.
36 builtin-TrAXBLVnyyKJQdar1e Peru ID card.
37 builtin-hra6Eb3IJsMuusbPfH Image AI-generation and PS detection.
38 builtin-5DgJZFnVtvqKdKy2rW Malaysia ID card

# 5.2 Recognition Result by Document Type (text)

# 5.2.1 builtin-7qguFU6sa5DmgHm08q

Field Name Type Description Example
other_person Integer Third person/other people: 0=empty/N/A, 1=none, 2=present 1
header_wear Integer Head accessory: 0=empty/N/A, 1=none, 2=hard hat, 3=riding helmet, 4=headscarf, 5=shower cap, 6=baseball cap, 7=beret, 8=top hat, 9=knit cap, 10=straw hat, 11=medical bandage, 12=other 0

# 5.2.2 builtin-0nZ0bZ09s9HqfjckoF

Field Name Type Description Example
names string Name SANDRA REGINA SALES
addrs string Address RUA RAY PALMEIRAS 88.57480-000
isTampered boolean Whether tampering detected false

# 5.2.3 builtin-RyLF2nZWGT2rMdU8S9

Field Name Type Description Example
scene_type Integer Scene type: 0=empty/N/A, 1=indoor, 2=outdoor 1
indoor_decoration_level Integer Decoration level: 0=empty/N/A, 1=none, 2=basic, 3=moderate, 4=refined, 5=indeterminable 3
indoor_decoration_style Integer Decoration style: 0=empty/N/A, 1=none, 2=minimal, 3=traditional rural, 4=basic modern, 5=economic simple, 6=mid-range modern, 7=industrial, 8=Nordic, 9=American, 10=light luxury, 11=luxury, 12=eclectic 6
indoor_wall_type Integer Wall type: 0=empty/N/A, 1=wood plank, 2=wood strip, 3=bamboo woven, 4=palm, 5=concrete, 6=exposed brick, 7=tin sheet, 8=PVC panel, 9=tile, 10=none, 11=other 9
indoor_roof_type Integer Roof type: 0=empty/N/A, 1=wood plank, 2=bamboo woven, 3=stone, 4=tin sheet, 5=cement, 6=corrugated, 7=raw cement, 8=solid paint, 9=ceiling, 10=tile, 11=thatch, 12=none, 13=other 9
indoor_curtain Integer Curtain: 0=empty/N/A, 1=present, 2=none 1
indoor_curtain_color Integer Curtain color: 0=empty/N/A, 1=white, 2=gray, 3=black, 4=khaki, 5=yellow, 6=orange, 7=pink, 8=red, 9=blue, 10=green, 11=purple, 12=color-block, 13=printed colorful, 14=gradient 2
indoor_curtain_type Integer Curtain type: 0=empty/N/A, 1=simple cloth, 2=sheer, 3=blinds, 4=roller, 5=Roman, 6=vertical, 7=bamboo, 8=canopy, 9=other 1
indoor_cleanliness Integer Room tidiness: 0=empty/N/A, 1=tidy, 2=average, 3=messy 2
indoor_clean_level Integer Room cleanliness: 0=empty/N/A, 1=clean, 2=average, 3=dirty 2
indoor_clothes_storage Integer Clothing storage: 0=empty/N/A, 1=no clothes, 2=casually piled, 3=casually hung, 4=neatly stored 4
indoor_item_storage Integer Item storage: 0=empty/N/A, 1=tidy & orderly, 2=slightly messy, 3=very messy, 4=no items 1
indoor_random_hanging_clothes Integer Casually hung clothes: 0=empty/N/A, 1=yes, 2=no 2
indoor_cooling_appliance Integer Cooling appliance: 0=empty/N/A, 1=none, 2=wall fan, 3=floor fan, 4=desk fan, 5=ceiling fan, 6=wall AC, 7=floor AC, 8=central AC, 9=other 6
indoor_power_socket Integer Power socket: 0=empty/N/A, 1=present, 2=none 1
indoor_socket_type Integer Socket type: 0=empty/N/A, 1=recessed, 2=surface-mount, 3=power strip 1
indoor_room_count Integer Room count: 0=empty/N/A, 1=single, 2=multiple, 3=corner area 1
indoor_room_type Integer Room type: 0=empty/N/A, 1=bedroom, 2=living room, 3=kitchen, 4=bathroom, 5=worker dorm, 6=grocery, 7=office, 8=warehouse, 9=wooden shed, 10=tin shed, 11=hospital ward, 12=storage room, 13=inside mall, 14=factory, 15=other 1
indoor_shop_type Integer Shop type: 0=empty/N/A, 1=kitchen supplies, 2=snacks, 3=daily supplies, 4=electronics, 5=toiletries, 6=general goods, 7=other 0
indoor_room_size Integer Room size: 0=empty/N/A, 1=small, 2=moderate, 3=spacious, 4=indeterminable 2
indoor_furniture_level Integer Furniture level: 0=empty/N/A, 1=no furniture, 2=cheap, 3=mid-range, 4=high-end, 5=indeterminable 3
other_person Integer Third person/other people: 0=empty/N/A, 1=none, 2=present 1
outdoor_scene_type Integer Outdoor type: 0=empty/N/A, 1=city street, 2=city square, 3=near city mall, 4=city residential, 5=rural street, 6=rural courtyard, 7=rural farmland, 8=open-air factory, 9=basic workshop, 10=inside vehicle, 11=park, 12=other 0
lighting Integer Lighting: 0=empty/N/A, 1=bright, 2=normal, 3=dim, 4=dark 2
urban_rural_type Integer Urban/rural: 0=empty/N/A, 1=large city, 2=small city, 3=county town, 4=suburb, 5=regular village, 6=poor village, 7=mountain area, 8=indeterminable 1
gender Integer Gender: 0=empty/N/A, 1=male, 2=female, 3=indeterminable 1
age_range Integer Age range: 0=empty/N/A, 1=1-10, 2=11-17, 3=18-25, 4=26-35, 5=36-45, 6=46-55, 7=55+ 4
head_wear Integer Head accessory: 0=empty/N/A, 1=none, 2=hard hat, 3=riding helmet, 4=headscarf, 5=shower cap, 6=baseball cap, 7=beret, 8=top hat, 9=knit cap, 10=straw hat, 11=medical bandage, 12=other 1
neck_wear Integer Neck accessory: 0=empty/N/A, 1=none, 2=necklace, 3=ID badge, 4=scarf, 5=neck brace/bandage, 6=headphones 1
ear_wear Integer Ear accessory: 0=empty/N/A, 1=none, 2=stud, 3=earring 1
glasses Integer Glasses: 0=empty/N/A, 1=none, 2=clear glasses, 3=dark glasses 2
face_appearance Integer Face appearance: 0=empty/N/A, 1=normal, 2=minor blemish, 3=partial scar/injury, 4=large scar, 5=disfigured, 6=deformity 1
facial_expression Integer Expression: 0=empty/N/A, 1=normal, 2=winking, 3=making faces, 4=weird grin, 5=exaggerated 1
facial_decoration Integer Face decoration: 0=empty/N/A, 1=tape, 2=heavy smear, 3=special marks, 4=props, 5=face mask, 6=none, 7=other decoration 6
beard_exist Integer Has beard: 0=empty/N/A, 1=yes, 2=no 2
beard_type Integer Beard type: 0=empty/N/A, 1=no beard, 2=stubble, 3=pencil mustache, 4=handlebar, 5=goatee, 6=full beard, 7=long full beard, 8=dragon whisker, 9=warrior, 10=other beard 1
face_shape Integer Face shape: 0=empty/N/A, 1=round, 2=oval, 3=square, 4=oblong, 5=heart, 6=triangle, 7=inverted triangle, 8=diamond, 9=other 2
eyebrow_type Integer Eyebrows: 0=empty/N/A, 1=straight, 2=willow leaf, 3=natural, 4=sword, 5=curved, 6=arched, 7=flat, 8=broken, 9=no brows, 10=sparse, 11=thick, 12=other eyebrows 11
eye_open_close Integer Eye open/close: 0=empty/N/A, 1=wide open, 2=naturally open, 3=half open, 4=closed, 5=squinting 2
eye_gaze Integer Gaze direction: 0=empty/N/A, 1=sideways, 2=forward, 3=downward, 4=upward 2
nose_type Integer Nose: 0=empty/N/A, 1=high bridge, 2=flat bridge, 3=hook, 4=upturned, 5=bulbous, 6=straight, 7=upturned tip, 8=wide, 9=narrow, 10=humped, 11=other nose type 6
mouth_type Integer Mouth: 0=empty/N/A, 1=M-shape, 2=petal, 3=pouty, 4=thin, 5=thick, 6=cherry, 7=sausage, 8=balanced, 9=upturned corners, 10=downturned corners, 11=other mouth type 8
face_fatness Integer Face fullness: 0=empty/N/A, 1=very thin, 2=thin, 3=normal, 4=plump, 5=very plump 3
face_attractiveness Integer Attractiveness: 0=empty/N/A, 1=very unattractive, 2=unattractive, 3=average, 4=attractive, 5=very attractive 3
upper_cloth_type Integer Top style: 0=empty/N/A, 1=no top, 2=underwear, 3=camisole/tank, 4=T-shirt, 5=short-sleeve shirt, 6=long-sleeve shirt, 7=hoodie/sweatshirt, 8=knit top, 9=jacket/coat, 10=workwear, 11=uniform, 12=vest, 13=ethnic/special, 14=other 4
upper_cloth_material Integer Top material: 0=empty/N/A, 1=cotton/linen, 2=synthetic, 3=wool, 4=silk, 5=velvet, 6=knit, 7=leather, 8=denim, 9=functional, 10=other 1
uniform_type Integer Uniform type: 0=empty/N/A, 1=security, 2=police/military, 3=medical, 4=delivery, 5=cleaning/maintenance, 6=construction, 7=manufacturing, 8=food service, 9=retail, 10=education, 11=transportation, 12=bank/government, 13=hotel, 14=religious, 15=other 0
clothing_scene_style Integer Clothing style: 0=empty/N/A, 1=casual, 2=loungewear, 3=uniform, 4=formal, 5=sportswear, 6=revealing 1
clothing_fit Integer Clothing fit: 0=empty/N/A, 1=loose, 2=normal, 3=tight 2
clothing_cleanliness Integer Clothing cleanliness: 0=empty/N/A, 1=clean, 2=light stains, 3=heavily soiled 1
clothing_color_mix Integer Color mix: 0=empty/N/A, 1=single color, 2=two-tone, 3=multi-color 1
upper_body_exposure Integer Upper body exposure: 0=empty/N/A, 1=covered, 2=small exposure, 3=large exposure, 4=fully exposed 1
tattoo_exists Integer Has tattoo: 0=empty/N/A, 1=yes, 2=no 2
tattoo_area Integer Tattoo size: 0=empty/N/A, 1=small, 2=medium, 3=large 0
tattoo_type Integer Tattoo type: 0=empty/N/A, 1=geometric, 2=nature/creature, 3=text/symbol, 4=traditional, 5=cartoon/trendy, 6=dark/mystic, 7=other 0
tattoo_position Integer Tattoo position: 0=empty/N/A, 1=neck, 2=arm, 3=chest, 4=back, 5=head, 6=face, 7=other 0
hair_color Integer Hair color: 0=empty/N/A, 1=white, 2=red, 3=green, 4=purple, 5=gray, 6=yellow, 7=black, 8=blonde, 9=other 7
hair_neatness Integer Hair neatness: 0=empty/N/A, 1=natural, 2=messy, 3=styled 1
hair_style_type Integer Hairstyle: 0=empty/N/A, 1=bald/receding, 2=buzz cut, 3=short, 4=ear-length, 5=shoulder-length, 6=chest-length, 7=waist-length, 8=very long, 9=special structure, 10=other 3
hair_volume Integer Hair volume: 0=empty/N/A, 1=receding hairline, 2=fully bald, 3=thin, 4=normal 4
wig_wear Integer Wearing wig: 0=empty/N/A, 1=yes, 2=no 2
hair_glossiness Integer Glossiness: 0=empty/N/A, 1=high gloss, 2=natural, 3=matte 2
body_shape Integer Body shape: 0=empty/N/A, 1=very thin, 2=thin, 3=normal, 4=plump, 5=very plump 3
holding_card Integer Holding card: 0=empty/N/A, 1=yes, 2=no 2
communication_device Integer Communication device: 0=empty/N/A, 1=none, 2=landline, 3=phone, 4=over-ear headphones, 5=wireless earbuds, 6=wired earbuds 3
pose_type Integer Pose: 0=empty/N/A, 1=standing, 2=leaning, 3=sitting, 4=squatting, 5=supine, 6=side-lying 1

# 5.2.4 builtin-ySmthSJqzQ3bN0Z9Y0

Field Name Type Description Example
quality Integer Image quality: 1=key visual info clear, 0=key visual info unclear/unrecognizable 1
issues String Quality issues enum: 1=blurry/low-res/out-of-focus, 2=glare, 3=too dark, 4=too bright, 5=other quality issues ["1","3"]

# 5.2.5 builtin-AsGltresBLOGouN1Pr

Field Name Type Description Example
sn String Store name ATK Duty-Free Store
sid String Store ID Store 0001
rid String Receipt number 0001
dt String Date/time 2025-11-20 21: 00
cid String Operator ID 0001
cn String Operator name ZHANG SAN
it String Item list
it.code String Item code 1234567890
it.name String Item name サラサクリップ 20色セット
it.qty String Quantity 1
it.pri String Unit price 1,000
it.amt String Line amount 1,000
it.taxFlag String Tax reduction/exempt flag 消
tax String Tax info
tax.rate String Tax rate 0.08
tax.base String Taxable amount 6,800
tax.tax String Tax amount 546
rem String Remarks 注)※印は軽減Tax rate適用商品
tq String Total quantity 7
ta String Total amount 9,137
cur String Currency JPY

# 5.2.6 builtin-FgYvNQQFGQ3o7qBVOe

Field Name Type Description Example
invoiceNumber String Invoice number 04
invoiceDate String Invoice date 2025-03-21
seller String Seller info
seller.name String Seller name JACK
seller.address String Seller address 210 Farm Hattingh
buyer String Buyer info
buyer.name String Buyer name BEN
buyer.address String Buyer address 22 Ferguson Road
lineitems Array Line items
lineitems.description String Description Foundation
lineitems.quantity Number Quantity 1
lineitems.unitPrice Number Unit price 100
lineitems.totalPrice Number Total price 1000
tax Number Tax amount 50
totalAmount Number Invoice total 3000

# 5.2.7 builtin-Dr2fttpaJzyOg2oGYZ

Field Name Type Description Example
title String Document title ##bank tracsaction
key_extraction Array Key info extraction
key_extraction.accountName String Account name Jack
key_extraction.accountNumber String Account number 1234567890123
key_extraction.currency String Currency CNY
key_extraction.regionCode String Currency code Local currency
key_extraction.dateRange String Date range 20230903-20240902
key_extraction.electronicSerialNumber String Electronic serial number 12345678901234
details Array Transaction details
details.User String Counterparty Mary
details.Date String Transaction date 20230906
details.Amount String Transaction amount
details.Transaction id String Transaction ID
details.Status String Transaction status
details.Notes String Transaction notes
summary Array Transaction summary
summary.Transaction time String Transaction time
summary.Income String Income
summary.Expense String Expense
summary.balance String Net
summary.QRIncome String QR income
sensitive String Sensitive risk items
top10 Array Top 10 transactions
top10.Counterparty String Counterparty
top10.Amount String Transaction amount
top10.recordCount String Record count
top10.Type String Transaction type
resources String Source file URL

# 5.2.8 builtin-siyppaCoUSYW1VImX9

Field Name Type Description Example
registry Array Company registration
registry.companyName String Company name PRO ELECT SARL
registry.legalForm String Legal form SARL
registry.commercialRegNumber String Commercial registration number A123456789
registry.nationalId String National tax ID M05231912784120L
registry.registryOffice String Registration office CDI DOUALA 5
registry.registrationDate String Registration date 2018-02-01
registry.companyDuration String Company duration 2050-02-01
contracts String Contracts
partners String Partners
authorizedSigners String Authorized signers
capital String Capital
mainAddress Array Company address
mainAddress.street String Street Happy Road
mainAddress.city String City Beijing
mainAddress.governorate String Province/state Chaoyang
mainAddress.country String Country China
mainAddress.ownedByCompany String Property owned by company true
branches String Branches
activities Array Business activities
activities.importExportRestricted String Import/export restricted true
activities.issuedOffice String Issuing office CDI DOUALA 5
activities.issueDate String Issue/expiry date 2025-12-31
taxCardInfo Array Tax card info
taxCardInfo.country String Country China
taxCardInfo.governmentDepartment String Government department Ministère des Finances
taxCardInfo.taxAuthority String Tax authority Direction Générale des Impôts
taxCardInfo.companyName String Company name PRO ELECT SARL
taxCardInfo.legalRepresentative String Legal representative Jack
taxCardInfo.companyType String Company type Sole-proprietorship enterprise
taxCardInfo.industry String Industry
taxCardInfo.address String Registered/operating address
taxCardInfo.provinceOrRegion String Province/region
taxCardInfo.taxCardNumber String Tax card number A123456789
taxCardInfo.commercialRegistrationDate String Commercial registration date 2020-02-01
taxCardInfo.taxRegistrationDate String Tax registration date 2020-02-02
phoneNumbers String Phone numbers 12345678901
lostANdFoundContact String Lost & found contact 12345678901
cardUsageNote String Card usage note For XTransfer enterprise verification only
foundInstructions String Found item instructions

# 5.2.9 builtin-8qUxGuXkYTm4U3lLxb

Field Name Type Description Example
BillingCompany String Gas company Petrotrade
CustomerName String Customer full name Jack
Address String Street 29.88 Road
CurrentReading Number Current meter reading 234
PreviousReading Number Previous meter reading 188
Consumption Number Gas consumption 46
NumberOFBills Number Number of bills 2
AmountDue Number Amount due 230
AmountInWords String Amount in words Two hundred and thirty
BillingPeriodFrom String Billing period from (YYYY-MM) 2025-01
BillingPeriodTo String Billing period to (YYYY-MM) 2025-02
BillId String Bill reference number 123456789012
IssueDate String Issue date (YYYY-MM-DD HH:MM:SS) 2025-02-03 11:22:33
CollectorName String Collector name Mary
City String Customer city Beijing
Branch String Branch/center Chaoyang
PaymentType String Payment type cash

# 5.2.10 builtin-u6OXNzMM68cMyqfCH8

Field Name Type Description Example
BillingCompany String Electricity company Horth Catto Electricity Distribution Co.
TaxNumber String Company tax number 156-176-210
BillID String Bill ID b9036650afbf4ft
PaymentCode String Payment code 01344519012500
IssueDate String Issue date (YYYY-MM-DD) 2025-04-13
City String Customer city Beijing
Area String Area/unit Chaoyang
CustomerName String Customer name Jack
Address String Customer address 24.56 Road
Description String Additional address details Floor 3
MeterNumber String Meter number 6154005
CurrentReading Number Current meter reading 254717
PreviousReading Number Previous meter reading 413
Consumption Number Consumption 254304
NumberOfBills Number Number of bills 1
AmountDue Number Amount due 580
TotalPaid Number Total paid 580
AmountInWords String Amount in words Five hundred and eighty

# 5.2.11 builtin-nGd1eMoYS2mBKgjYQ6

Field Name Type Description Example
certNo String Property certificate number 108北士字第000001号
owner String Owner name 张三
ownerId String Owner unified ID(similar to personal ID number or company registration number) 1234567890123
lot String Lot number 朝阳区0001
houseNo String House number 幸福路123号三楼
floor String Floor 三层

# 5.2.12 builtin-ZXELuKZ7SXPGWmixZE

Field Name Type Description Example
name String Certificate holder name 张三
id String Holder Taiwan ID A123456789
bDateTw String Birth date (Taiwan format), format"Minguo year month day" 民國70年05月12日
bDate String Birth date (YYYY-MM-DD) 1981-05-12
certNo String Certificate number (xx)XX字第XXX號
issDateTw String Issue date (Taiwan format), format"Minguo year month day" 民國70年05月12日
issDate String Issue date (YYYY-MM-DD) 1981-05-12
issuer String Issuer name/place 高雄市政府地政局

# 5.2.13 builtin-lcDhAaeQMJcOandoBP

Field Name Type Description Example
is_tampered Boolean true=tampered, false=no tampering false
tampered_positions Array Tampered positions: each element is a rect region with 8 corner coords [TL, TR, BR, BL]; multiple regions possible [366,404,409,404,409,431,366,431]

# 5.2.14 builtin-yQU9ZpfsRuFeNUy4aw

Field Name Type Description Example
detailed_statement String Transaction details
detailed_statement.balance String Post-transaction balance 94.66
detailed_statement.completion_time String Completion time 2025-10-11 14:39:57
detailed_statement.details String Transaction details Customer Transfer of Funds Charge
detailed_statement.paid_in String Paid in (income) 2000.00
detailed_statement.receipt_no String Receipt number TJBFM75IEL
detailed_statement.transaction_status String Transaction status Completed
detailed_statement.withdrawn String Withdrawn (expense) -7.00
m_pesa_statement String M-PESA statement
m_pesa_statement.customer_name String Customer name Jack
m_pesa_statement.email_address String Email credit@flsshpesa.k0
m_pesa_statement.mobile_number String Mobile number 0727610015
m_pesa_statement.request_date String Statement request date 13 Oct 2025
m_pesa_statement.statement_period String Statement period 13 Sep 2025 - 13 Oct 2025
summary String Summary by transaction type
summary.paid_in String Total paid in 0.00
summary.paid_out String Total paid out 4,891.00
summary.transaction_type String Transaction type SEND MONEY:

# 5.2.15 builtin-GehZrc2wddibKXSAWb

Field Name Type Description Example
countryCode String Country code CHN
passportNumber String Passport number E40898665
fullNameLocal String Full name (local) 张三
fullNameLatin String Full name (Latin) ZHANG SAN
surname String Surname ZHANG
givenName String Given name SAN
middleName String Middle name null
nationality String Nationality CHINESE
dateOfBirth String Date of birth, format:YYYY-MM-DD 2009-09-09
sex String Gender, F=female, M=male F
placeOfBirth String Place of birth 河北
placeOfIssue String Place of issue 河北
dateOfIssue String Issue date, format:YYYY-MM-DD 2015-01-06
dateOfExpiry String Expiry date, format:YYYY-MM-DD 2020-01-05
issuingAuthority String Issuing authority 公安部出入境管理局
isPP Boolean Whether passport, true=yes, false=no true

# 5.2.16 builtin-laCUS0pQTRGOrEas0l

Card Type Field Type Description Example
All cardType string Card Type, UMID, SSS_ID, PASSPORT, DRIVER_LICENSE, NATIONAL_ID, POSTAL_ID, PRC_ID UMID
UMID crn string Card number / CRN 0020-1215160-9
UMID surname string Surname SANTOS
UMID givenName string Given name JOSE
UMID middleName string Middle name CRUZ
UMID fullName string Full name (given + middle + surname) JOSE CRUZ SANTOS
UMID gender string Gender M / F
UMID dob string Date of birth, YYYY-MM-DD 1960-01-28
UMID address string Full address, lines merged 28 PAYAPA ST BAGONG DIWA STO CRISTOBAL CALOOCAN CITY METRO MANILA PHILIPPINES 1800
SSS_ID no string Social Security number 02-2102579-6
SSS_ID name string Full name MARVIN GALANG PANGAN
SSS_ID dob string Date of birth, YYYY-MM-DD 1984-12-13
PASSPORT country string ISO country code PHL
PASSPORT type string Passport type P
PASSPORT no string Passport number P1234567
PASSPORT nameLocal object Local name structure {full, surname, givenName, middleName}
PASSPORT nameLatin object Latin name structure {full, surname, givenName, middleName}
PASSPORT nationality string Nationality Filipino
PASSPORT dob string Date of birth, YYYY-MM-DD 1990-01-01
PASSPORT sex string Gender M / F
PASSPORT pob string Place of birth QUEZON CITY
PASSPORT issPlace string Place of issue null
PASSPORT issDate string Issue date, YYYY-MM-DD 2015-06-01
PASSPORT expiryDate string Expiry date, YYYY-MM-DD 2025-06-01
PASSPORT issAuthority string Issuing authority DFA Manila
PASSPORT MRZ object Machine-readable zone {line1, line2}
DriverLicense name string Full name DELA CRUZ, JUAN PEDRO GARCIA
DriverLicense nationality string Nationality PHL
DriverLicense gender string Gender M / F
DriverLicense dob string Date of birth, YYYY-MM-DD 1995-08-15
DriverLicense weight string Weight(kg) 60
DriverLicense height string Height(m) 1.70
DriverLicense address string Address, lines merged 1123 YOUR ADDRESS, MANILA, 1008 METRO MANILA, PHILIPPINES
DriverLicense no string Driver's license number D23-52 867231
DriverLicense expiryDate string Expiry date, YYYY-MM-DD 2024-04-11
DriverLicense agencyCode string Issuing agency code D24
DriverLicense bloodType string Blood type A+
DriverLicense eyesColor string Eye color BLACK
DriverLicense restrictions string License restrictions 1,2
DriverLicense conditions string License conditions NONE
NATIONAL_ID no string PhilSys card number / primary ID 1234-5678912-3
NATIONAL_ID givenName string Given name JUAN
NATIONAL_ID middleName string Middle name MARTINEZ
NATIONAL_ID surname string Surname DELA CRUZ
NATIONAL_ID gender string Gender M / F
NATIONAL_ID dob string Date of birth, YYYY-MM-DD 1990-01-01
NATIONAL_ID pob string Place of birth QUEZON CITY
NATIONAL_ID blood string Blood type O
NATIONAL_ID marital string Marital status Single
NATIONAL_ID address string Address, lines merged 01 SAMPALOC, MANILA CITY, METRO MANILA
NATIONAL_ID issDate string Issue date, YYYY-MM-DD 2015-06-01
PostalID no string Postal ID number / PRN CA314000001-B
PostalID name string Full name MA. JOSEFINA M. DELA CRUZ
PostalID address string Address, lines merged 662 Mendoza St. Lolomboy Bocaue Bulacan 3018
PostalID dob string Date of birth, YYYY-MM-DD 1958-02-24
PostalID nationality string Nationality Filipino
PostalID expiryDate string Expiry date, YYYY-MM-DD 2017-11-04
PostalID issOffice string Issuing post office MNL CPO
PRCID lastName string Surname DUMANDAN
PRCID firstName string Given name GLORIO JR
PRCID middleName string Middle name ORTEGA
PRCID regNo string Registration number 003978
PRCID regDate string Registration date, YYYY-MM-DD 2008-10-30
PRCID expiryDate string Expiry date, YYYY-MM-DD 2011-05-16
PRCID profession string Occupation / Profession CRIMINOLOGIST
TIN_ID name string Cardholder name DELA CRUZ, JUAN
TIN_ID tin string Taxpayer Identification Number 123-456-789-000
TIN_ID address string Address 28 Payapa St. Bagong Diwa Sto. Cristobal, Caloocan City
TIN_ID dob string Date of birth, YYYY-MM-DD 1994-09-04
TIN_ID issDate string Issue date, YYYY-MM-DD 2017-10-02
VOTER_ID vin string Voter identification number VIN 7404-2491C-D2843TPR10000
VOTER_ID name string Cardholder name REYES TEODORO PANGLINAN
VOTER_ID dob string Date of birth, YYYY-MM-DD 1943-04-26
VOTER_ID status string Marital status, as on card Married
VOTER_ID citizenship string Citizenship/nationality Filipino
VOTER_ID address string Address B17 L21 VILLANOVA SUBD., NAGKAISANG NAYON
VOTER_ID precinct string Voting precinct number / Precinct No. 2491C
VOTER_ID issDate string Issue/registration date, YYYY-MM-DD 2023-11-29
OWWA_ID name string Cardholder name REYES TEODORO PANGLINAN
OWWA_ID dob string Date of birth, YYYY-MM-DD 1982-10-05
OWWA_ID gender string Gender, M/F M
OWWA_ID address string Address B17 L21 VILLANOVA SUBD., NAGKAISANG NAYON
OWWA_ID no string OFW ID / OFW e-CARD number OWWA000001
OWWA_ID issDate string Issue date, YYYY-MM-DD 1982-10-05
GSIS_ID name string Cardholder name JUANA DE LA CRUZ
GSIS_ID no string GSIS number 123456789012
GSIS_ID bankNo string Bank card number 4000 0076 1978 0014
GSIS_ID dob string Date of birth, YYYY-MM-DD 1960-01-28
GSIS_ID gender string Gender, M/F F
GSIS_ID address string Address 28 Payapa St. Bagong Diwa Sto. Cristobal Caloocan City, MM 1800
GSIS_ID validThru string Validity; returns YYYY-MM when precise to month, YYYY-MM-DD when precise to day 2008-09
PHILHEALTH_ID name string Cardholder name DARIO, ANDINO BALANA
PHILHEALTH_ID no string PhilHealth card number / PIN 02-050329439-8
PHILHEALTH_ID dob string Date of birth, YYYY-MM-DD 1987-04-05
PHILHEALTH_ID gender string Gender, M/F M
PHILHEALTH_ID address string Address 29 B5 SITIO MA CORAZON PH2 SANTA CRUZ ANTIPOLO CITY, RIZAL - 1870
PAGIBIG_ID name string Cardholder name JUANA A. DELA CRUZ
PAGIBIG_ID no string Pag-IBIG MID number / member number 1023-4567-8090

# 5.2.17 builtin-NHq96vD0BhlbEivKLr

Field Name Type Description
age_range Integer Age range: 0=empty/N/A, 1=1-10, 2=11-17, 3=18-25, 4=26-35, 5=36-45, 6=46-55, 7=55+
eye_open_close Integer Eyes open/closed: 0=empty/N/A, 1=wide open, 2=naturally open, 3=half open, 4=closed, 5=squinting
facial_decoration Integer Face decoration: 0=empty/N/A, 1=tape, 2=heavy smear, 3=special marks, 4=props, 5=face mask, 6=none, 7=other decoration
facial_expression Integer faceExpression: 0=empty/N/A, 1=normal, 2=winking, 3=making faces, 4=weird grin, 5=exaggerated
gender Integer Gender: 0=empty/N/A, 1=male, 2=female, 3=indeterminable
head_wear Integer head wear: 0=empty/N/A, 1=no hard hat, 2=hard hat, 3=riding helmet, 4=headscarf, 5=shower cap, 6=baseball cap, 7=beret, 8=top hat, 9=knit cap, 10=straw hat, 11=medical bandage, 12=other
mouth_type Integer MouthType: 0=empty/N/A, 1=M-shape, 2=petal, 3=pouty, 4=thin, 5=thick, 6=cherry, 7=sausage, 8=balanced, 9=upturned corners, 10=downturned corners, 11=other mouth type
neck_wear Integer neck wear: 0=empty/N/A, 1=none, 2=necklace, 3=ID badge, 4=scarf, 5=neck brace/bandage, 6=headphones
nose_type Integer NoseType: 0=empty/N/A, 1=high bridge, 2=flat bridge, 3=hook, 4=upturned, 5=bulbous, 6=straight, 7=upturned tip, 8=wide, 9=narrow, 10=humped, 11=other nose type
wig_wear Integer Wig wearing: 0=empty/N/A, 1=yes, 2=no

# 5.2.18 builtin-MBl1quBumLoVtYUZVq

Field Name Type Description
age_range Integer Age range: 0=empty/N/A, 1=1-10, 2=11-17, 3=18-25, 4=26-35, 5=36-45, 6=46-55, 7=55+
eye_open_close Integer Eyes open/closed: 0=empty/N/A, 1=wide open, 2=naturally open, 3=half open, 4=closed, 5=squinting
facial_decoration Integer Face decoration: 0=empty/N/A, 1=tape, 2=heavy smear, 3=special marks, 4=props, 5=face mask, 6=none, 7=other decoration
facial_expression Integer faceExpression: 0=empty/N/A, 1=normal, 2=winking, 3=making faces, 4=weird grin, 5=exaggerated
gender Integer Gender: 0=empty/N/A, 1=male, 2=female, 3=indeterminable
indoor_cleanliness Integer Room tidiness: 0=empty/N/A, 1=tidy, 2=average, 3=messy
lighting Integer Lighting: 0=empty/N/A, 1=bright, 2=normal, 3=dim, 4=dark
pose_type Integer Pose type: 0=empty/N/A, 1=standing, 2=leaning, 3=sitting, 4=squatting, 5=supine, 6=side-lying
scene_type Integer Scene type: 0=empty/N/A, 1=indoor, 2=outdoor
tattoo_area Integer Tattoo size: 0=empty/N/A, 1=small, 2=medium, 3=large

# 5.2.19 builtin-SrFi52OPlDGKSQmjvZ

Field Name Type Description Example
name string Cardholder name 林小明
dateOfBirth string Cardholder date of birth, as on card original format 民國72年1月1日
gender string Gender 男
issueDate string Issue date as on card; includes region/reissue notes if present 民國107年10月15日(北市)换發
nationalID string Taiwan unified ID number A123456789

# 5.2.20 builtin-UqDwMvWDRD05zCm0BG

Field Name Type Description Example
name string Cardholder name 张三
gender string Gender, male/female 男
dob string Cardholder date of birth, format:YYYY-MM-DD 2000-01-01
address string Cardholder residential address 北京市朝阳区xxx号
no string Taiwan residence permit number 12345678901234567
issAuthority string Document issuing authority 北京市朝阳区和平分局
issDate string Document issue date, format:YYYY-MM-DD 2019-01-01
expiryDate string Document expiry date, format:YYYY-MM-DD 2024-01-01
renew string Renewal count 01
permitNo string Mainland Travel Permit number 12345678

# 5.2.21 builtin-5Rfhqo1A3MGROHUNJJ

Supports 5 Pakistan ID types: 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), types outside the above are recognized asother(other).

Field Name Type Description Applicable Card Example
no string Cardholder ID number Front of all 5 card types 34101-5378249-5
name string Cardholder name(English) Front of all 5 card types Adeel Sajjad
fatherName string Father's name (English); empty if unavailable Front of all 5 card types Sajjad Ahmed
husbandName string Spouse name (English, married females only); empty if unavailable Front of all 5 card types
gender string Gender; values M (male), F (female), X (third gender) Front of all 5 card types M
dob string Cardholder date of birth, format YYYY-MM-DD Front of all 5 card types 2000-08-12
countryOfStay string Country of residence Front of all 5 card types Pakistan
issDate string Document issue date, format YYYY-MM-DD NICOP back, front of other 4 types 2024-11-17
expiryDate string Document expiry date, format YYYY-MM-DD NICOP back, front of other 4 types 2034-11-17
presentAddress string Current address, mostly Urdu Back of all 5 card types
permanentAddress string Permanent address, mostly Urdu Back of all 5 card types
type string "cnic": Computerized National Identity Card, national ID card for Pakistani citizens; the front has no chip, and the card face content is usually in Urdu. "snic": Smart National Identity Card, Pakistan's smart citizen ID card with a chip; the front contains a chip. "nicop": National Identity Card for Overseas Pakistanis, national ID card for overseas Pakistani citizens. "poc": Pakistan Origin Card, for foreign citizens with Pakistani descent or ties. "arc": Alien Registration Card, for foreigners registered in Pakistan. "other": other types beyond the above. snic

# 5.2.22 builtin-eK6p0vOB1AZmpGhLi9

Field Name Type Description Example
idNo string Bangladesh ID number ID No. 8704637043
name string Cardholder English name MD. SHIPON MIA
localName string Local language name মোঃ শিপন মিয়া
fatherName string Father's name, usually local language মোঃ সাজু মিয়া
motherName string Mother's name, usually local language মোছাঃ শিল্পী বেগম
dob string Cardholder date of birth, format: YYYY-MM-DD 1998-09-25
gender string Gender; F/M, empty if not shown F
blood string Blood type; empty if not shown A+
address string Address; empty if not shown
pob string Place of birth; empty if not shown JHALOKATI
issDate string Document issue date, format: YYYY-MM-DD; may be empty if not shown 2026-11-03
expiryDate string Document expiry date, format YYYY-MM-DD; empty if not shown/unrecognizable 2036-11-03

# 5.2.23 builtin-6UOFfK0g1gMvgCHx19

Card Type Field Name Type Description Example
CITIZEN_CARD cardType string Document type, fixed value CITIZEN_CARD CITIZEN_CARD
CITIZEN_CARD no string Citizen ID number, usually corresponds to No BI / Card No, No BI or Card No 0600506125463002
CITIZEN_CARD name string Cardholder name, usually corresponds to Nome do Titular / Full Name MARIA DA SILVA
CITIZEN_CARD marital string Marital status, usually corresponds to Estado Civil / Marital Status CASADO
CITIZEN_CARD gender string Gender; values M, F F
CITIZEN_CARD height string Height, without unit 155
CITIZEN_CARD dob string Date of birth, format: YYYY-MM-DD 1990-05-12
CITIZEN_CARD pob string Place of birth, usually corresponds to Naturalidade / Place of Birth DILI
CITIZEN_CARD nationality string Nationality, usually corresponds to Nacionalidade / Nationality TIMORENSE
CITIZEN_CARD fatherName string Father's name; if the parents' names are not clearly distinguished, usually the first line of the parents' info is taken JOSE DA SILVA
CITIZEN_CARD motherName string Mother's name; if the parents' names are not clearly distinguished, usually the second line of the parents' info is taken ANA MARIA
CITIZEN_CARD address string Residential address, usually corresponds to Residência / Address DILI, TIMOR-LESTE
CITIZEN_CARD issDate string Issue date, format: YYYY-MM-DD 2020-01-15
CITIZEN_CARD expiryDate string Expiry date, format YYYY-MM-DD 2030-01-15
DRIVING_LICENSE cardType string Document type, fixed value DRIVING_LICENSE DRIVING_LICENSE
DRIVING_LICENSE no string Driver's license number or card number, usually corresponds to fields such as No CC 03029/DNTT/C/IV/09
DRIVING_LICENSE name string Cardholder name JOAO PEREIRA
DRIVING_LICENSE nationality string Nationality or place of birth info shown on the document, returned as on the original TIMOR-LESTE
DRIVING_LICENSE dob string Date of birth, format: YYYY-MM-DD 1988-03-20
DRIVING_LICENSE address string Address, usually corresponds to Morada DILI
DRIVING_LICENSE gender string Gender; values M, F M
DRIVING_LICENSE eyes string Eye color, usually corresponds to Olhos Castanhos
DRIVING_LICENSE height string Height, returned as on the card, without unit 180
DRIVING_LICENSE blood string Blood type, usually corresponds to G. Sanguineo O
DRIVING_LICENSE issDate string Issue date, format: YYYY-MM-DD 2016-04-10
DRIVING_LICENSE expiryDate string Expiry date, format YYYY-MM-DD 2026-04-10
PASSPORT cardType string Document type, fixed value PASSPORT PASSPORT
PASSPORT country string Issuing country ISO 3166-1 alpha-3 code TLS
PASSPORT Type string Passport type code P
PASSPORT no string Passport number P1234567
PASSPORT surname string Cardholder surname/family name, as on passport GUTERRES
PASSPORT givenName string Cardholder given name, as on passport JOSE
PASSPORT nationality string Nationality, as on passport TIMORESE
PASSPORT dob string Date of birth, format: YYYY-MM-DD 1990-06-15
PASSPORT sex string Gender; values M, F M
PASSPORT pob string/null Place of birth, as on passport; null if not shown null DILI
PASSPORT issDate string Issue date, format: YYYY-MM-DD 2021-05-01
PASSPORT expiryDate string Expiry date, format YYYY-MM-DD 2031-05-01
PASSPORT issAuthority string/null Issuing authority; null if not shown null MINISTRY OF JUSTICE
PASSPORT line1 string MRZ line 1, usually starts with P< P<TLSGUTERRES<<JOSE<<<<<<<<<<<<<<<<
PASSPORT line2 string MRZ line 2, passport no, nationality, DOB, expiry etc. P1234567<TLS9006151M3105012<<<<<<<<
VOTER_CARD cardType string Document type, fixed value VOTER_CARD VOTER_CARD
VOTER_CARD cardNo string Voter card number, usually corresponds to fields such as Nú Cartão, No. Cartão, Nú. Kartaun 123456
VOTER_CARD regNo string Registration/document number, usually corresponds to fields such as Nú De Inscrição, No. Doc, Nú. Dok 987654321
VOTER_CARD name string Cardholder name, usually corresponds to Nome / Naran JOAO DA COSTA
VOTER_CARD dob string Date of birth, format: YYYY-MM-DD 1995-08-10
VOTER_CARD pob string Place of birth, usually corresponds to Naturalidade / Moris Fatin BAUCAU
VOTER_CARD municipality string Municipality, usually corresponds to Município DILI
VOTER_CARD post string Administrative post, usually corresponds to Posto Adm. DOM ALEIXO
VOTER_CARD suco string Suku/Suco, the name of a village/town or grassroots area COMORO
VOTER_CARD aldeia string Aldeia, the name of a grassroots residential area 30 DE AGOSTO

# 5.2.24 builtin-86og0wZ7HLhSXlYG7p

Field Name Type Description Example
idNo string Vietnam ID/citizen number 001096840920
name string Cardholder name, returned as on the card NÔNG VAN HIEU
gender string Gender, M=male, F=female M
bDate string Cardholder date of birth, format: YYYY-MM-DD 1996-05-16
nationality string Cardholder nationality, returned as on the card Việt Nam
origin string Origin/birthplace(Quê quán), returned as on the card Chi Dông, Mê Linh, Hà Noi
res string Permanent/residential address(Nơi thường trú), returned as on the card To 2, Chi Dong, Me Linh, Hà Noi
expiryDate string/null Expiry date, format YYYY-MM-DD; returns null when no validity 2028-05-16
issueDate string/null Issue date, format YYYY-MM-DD 2021-06-21
issuer string/null Document issuing authority CUC TRUONG CUC CANH SAT QUAN LY HANH CHINH VE TRAT TU XA HOI
qrData object/null QR parse result; null if not found null -
+idNo string From QR:ID number 001096840920
+oldIdNo string/null From QR:old ID number; returns null if absent 012345678
+name string From QR:Name NÔNG VAN HIEU
+bDate string From QR:Date of birth, format: YYYY-MM-DD 1996-05-16
+gender string From QR:Gender(original value) Nam / Nữ
+res string From QR:Residential address To 2, Chi Dong, Me Linh, Hà Noi
+issueDate string From QR:Issue date, format: YYYY-MM-DD 2021-06-21

# 5.2.25 builtin-IPC3Peq8NRXRxr4ZbE

Field Name Type Description Example
no string Cambodia ID number 190457306
fullNameLatin string Latin name VANN VIREAK
fullNameLocal string Local language name វ៉ាន់ វីរៈ
gender string Gender; values M, F M
dob string Cardholder date of birth, format: YYYY-MM-DD 1967-11-13
height string Height, as on card ១៦១ ស.ម
issDate string Document issue date, format: YYYY-MM-DD 2015-10-08
expiryDate string Document expiry date, format YYYY-MM-DD 2035-07-07
nationality string Nationality or country code KHM
pob string Place of birth, as on card ឃុំអន្លង់វិល ស្រុកសង្កែ បាត់ដំបង
address string Address, as on card ភូមិត្រពេច ស្រុកថ្មពួក បន្ទាយមានជ័យ
identifyingMarks string Identifying marks ប្រជ្រុយចំ ០.៥សម មុខលើគល់ភ្នែកស្តាំ
mrzLine1 string MRZ line 1 content IDKHM1904573061<<<<<<<<<<<<<<<<
mrzLine2 string MRZ line 2 content 6711137M3507072KHM<<<<<<<<<<<<4
mrzLine3 string MRZ line 3 content VANN<<VIREAK<<<<<<<<<<<<<<<<<<<

# 5.2.26 builtin-cimngo8Kfy06XJ6Wk8

Card Type Field Name Type Description Example
ID_CARD cardType string Document type enum ID_CARD
ID_CARD no string ID number, 11+ digits, may contain spaces 12345678901
ID_CARD surame string Surname / family name ADELEYE
ID_CARD givenName string Given name / primary name JOHN
ID_CARD middleName string Middle name, as on card, not to be inferred MICHAEL
ID_CARD dob string Date of birth, format YYYY-MM-DD 1990-05-12
ID_CARD issDate string Document issue date, format YYYY-MM-DD 2015-10-08
ID_CARD expiryDate string Document validity, format YYYY-MM or YYYY-MM 2029-05
PASSPORT cardType string Document type enum PASSPORT
PASSPORT country string ISO 3166-1 alpha-3 Country code NGA
PASSPORT Type string Passport type, e.g. P/D P
PASSPORT no string Passport number A1234567
PASSPORT +nameLocal object/null Local-language name structure { "full":"...", "surname":"...", "givenName":"..."}
+nameLocal.full string Local-language full name አልሃምዱ ዲነካ ሬዳ
+nameLocal.surname string Local-language surname / family name ዲነካ
+nameLocal.givenName string Local-language given name አልሃምዱ
+nameLocal.middleName string Local-language middle name(if present) ሬዳ
PASSPORT +nameLatin object Latin-letter name structure { "full":"...", "surname":"...", "givenName":"..."}
+nameLatin.full string Latin-letter full name ALHAMDU DINEKA REDA
+nameLatin.surname string Latin-letter surname / family name DINEKA
+nameLatin.givenName string Latin-letter given name ALHAMDU
+nameLatin.middleName string Latin-letter middle name(if present) REDA
PASSPORT nationality string Nationality NIGERIA
PASSPORT dob string Date of birth, format YYYY-MM-DD 1990-05-12
PASSPORT gender string Gender, M/F M
PASSPORT pob string/null Place of birth LAGOS
PASSPORT issPlace string/null Place of issue null
PASSPORT issDate string Issue date, YYYY-MM-DD 2015-10-08
PASSPORT expiryDate string Validity, YYYY-MM-DD 2025-10-08
PASSPORT issAuthority string/null Issuing authority MINISTRY OF FOREIGN AFFAIRS
PASSPORT MRZ object Machine-readable zone info { "line1":"...", "line2":"..." }
+MRZ.line1 string MRZ line 1, usually starts with P< P<NLSNAME<<GIVEN<<<<<<<<<<<<
+MRZ.line2 string MRZ line 2, passport no, nationality, DOB, expiry etc. P1234567<NGA9006151M2510082<<<<<<<<<<
DRIVING_LICENSE cardType string Document type enum DRIVING_LICENSE
DRIVING_LICENSE no string Driver's license number 03029/DNTT/C/IV/09
DRIVING_LICENSE class string Driver's license class C
DRIVING_LICENSE name string Cardholder name JOHN MICHAEL ADELEYE
DRIVING_LICENSE gender string Gender, M/F M
DRIVING_LICENSE address string/null Residential address null
DRIVING_LICENSE dob string Date of birth, YYYY-MM-DD 1990-05-12
DRIVING_LICENSE issDate string Issue date, YYYY-MM-DD 2015-10-08
DRIVING_LICENSE expiryDate string Validity, YYYY-MM-DD 2025-10-08
VOTER_CARD cardType string Document type enum VOTER_CARD
VOTER_CARD vin string Voter ID number (VIN) 123456
VOTER_CARD code string Polling station code 987
VOTER_CARD delim string String containing state/local government/ward LAGOS IKEJA WARD1
VOTER_CARD name string Cardholder name JOHN MICHAEL ADELEYE
VOTER_CARD gender string Gender, M/F M
VOTER_CARD dob string Date of birth, YYYY-MM-DD 1990-05-12
VOTER_CARD occupa string Occupation Teacher
VOTER_CARD address string/null Residential address null

# 5.2.27 builtin-KMw0wDDdzSTs62jD6v

Field Name Type Description Example
surname string Cardholder surname / family name IMMELMAN
names string Cardholder name / given name WAYNE LEE
gender string Gender, possible values M or F M
nationality string Nationality, as on card RSA
no string South Africa ID number, usually a 13-digit string 8510315120089
dob string Date of birth, format YYYY-MM-DD 1985-10-31
pob string Place of birth / Country of Birth, as on card RSA
status string Citizenship status CITIZEN
issDate string Document issue date, format: YYYY-MM-DD 2015-10-08

# 5.2.28 builtin-inpf3JKw4iBGRg6o1K

Field Name Type Description Example
nameLocal string Local name, usually Amharic አልሃምዱ ዲነካ ሬዳ
nameLatin string Latin name, as on card Alhamdu Dineka Reda
gender string Gender; values M, F M
dobLocal string Cardholder date of birth, Ethiopian calendar date, format YYYY-MM-DD 1996-01-01
dob string Cardholder date of birth, Gregorian date, format YYYY-MM-DD 2003-09-12
nationalityLocal string Cardholder local nationality ኢትዮጵያዊ
nationality string Cardholder English nationality Ethiopian
fan string FAN number, as on card; excluding the FAN label; empty if not shown 4195302617209485
fin string FIN number, as on card; excluding the FIN label; empty if not shown 581260930236
fcn string FCN number, as on card; excluding the FCN label; empty if not shown 2132836096158706
issDateLocal string Issue date, Ethiopian calendar, format YYYY-MM-DD 2017-07-15
issDate string Issue date, Gregorian, format YYYY-MM-DD 2025-03-24
expiryDateLocal string Expiry date, Ethiopian calendar, format YYYY-MM-DD 2025-08-13
expiryDate string Expiry date, Gregorian, format YYYY-MM-DD 2033-04-21
printDate string Print date, Gregorian, format YYYY-MM-DD 2024-06-13
phone string Phone, usually on back 0912662007
addressLocal string Cardholder local address, usually on the back; Amharic lines, comma-merged ኦሮሚያ, ቢሾፍቱ, ኦዳ ናቤ
address string Cardholder English/Latin address, usually on the back; comma-merged Oromia, Bishoftu City Administration - Dukam, Oda Nabe

# 5.2.29 builtin-YgWCVSXqZ0qj8I31Rg

Field Name Type Description Example
compliant boolean Overall compliance check; true means the photo meets all selfie requirements, false means at least one violation exists false
violations array Violation items array; empty [] if no violations [] ["not_front","mouth_open"]
+no_face string No recognizable face detected in the image, or the image is not a portrait no_face
+not_front string Face not facing the camera, or both eyes not looking forward not_front
+smiling string Obvious smile/laugh present smiling
+mouth_open string Mouth clearly open, exposing the inside of the mouth, tongue, or teeth mouth_open
+head_occluded string Head or top of head obscured by an object; obstruction due to religious or medical reasons is acceptable head_occluded
+eyes_closed string One or both eyes closed eyes_closed
+red_eyes string Obvious red-eye effect in one or both eyes red_eyes
+glasses_reflection string Obvious reflection or shadow on regular glasses lenses glasses_reflection
+sunglasses string Wearing sunglasses, dark shades, or dark glasses sunglasses
+multiple_faces string Multiple faces or other suspected face regions in the image multiple_faces
+face_covered string Face obscured by an object, smearing, or other content face_covered
+blur string Portrait photo obviously blurry due to low resolution, out-of-focus, or camera shake blur
+bright string Face area obviously too bright or overexposed, affecting facial feature recognition bright
+cropped string Head or face beyond the image boundary, not fully in frame cropped
+dark string Face area severely too dark, affecting face outline or key feature recognition dark

# 5.2.30 builtin-Li4ZATHXbMQQa66gPi

Field Name Type Description Example
no string Overseas ID / NIC number 313049-028789-5
name string Full name (Latin) Muhammad Amjad
fatherName string Father's name (Latin) Muhammad Latif
gender string Gender M / F / ""
dob string Date of birth 1996-01-01
countryOfStay string Country of residence United Arab Emirates
presentAddress string Current address, merged PO bandi mera, Bandi Mera, Teh and Distt Abbottabad, Pakistan
permanentAddress string Permanent address, merged PO bandi mera, Bandi Mera Teh and Distt Abbottabad, Pakistan
issDate string Issue date 2014-08-07
expiryDate string Expiry date 2024-08-07
visaFreeEntry string Visa-free entry eligibility ENTITLED / NOT_ENTITLED / UNKNOWN
mrzLine1 string MRZ line 1 I<PAK13101500414798XPPN1<<<<
mrzLine2 string MRZ line 2 950304M2408079PAK927FC5W<<<<3
mrzLine3 string MRZ line 3 BASHIR<<WAQAR<<<<<<<<<<<

# 5.2.31 builtin-Kc19djI2nepOIrFrjy

Field Name Type Description Example
serialNo string Serial number, usually on left or top A1234567
no string ID / HUDUMA / MAISHA number 12345678
name string Full name JOHN MWANGI KAMAU
dob string Date of birth, unified format YYYY-MM-DD 1990-08-30
gender string Gender, M=male / F=female M
nationality string Nationality KEN
pob string Place/district of birth NAIROBI
issPlace string Place of issue NAIROBI
issDate string Issue date, YYYY-MM-DD 2020-12-04
expiryDate string Expiry date, YYYY-MM-DD 2033-12-04

# 5.2.32 builtin-RpAJLFfches2ML9fH9

Field Name Type Description Card Side Example
idNo string ID number front 99999999
surName string Surname / family name front GARCIA
givenName string Given name / multiple front JUAN CARLOS
gender string Gender front M / F
nationality string Nationality front ARGENTINA
renew string Version ID front A / B
dob string Date of birth front 2016-02-22
issDate string Issue date front 2023-04-20
expiryDate string Validity front 2038-10-30
address string Address(original text) back GENERAL RODRIGUEZ PAZ 83
pob string Place of birth back CHILE
cuil string Tax/labor number back 27-99999999-0

# 5.2.33 builtin-ftEObTXXN9m03VXmwZ

Note: Returns an array; each element is a transaction record with 4 fields: time, amount, counterparty, and post-transaction balance.

Field Name Type Description Example
time string Transaction time. Supported formats: YYYY-MM-DD, YYYY-MM-DD HH:MM:SS, HH:MM:SS .Empty string if time not visible/unrecognizable. 2026-05-24 18:31:00
amount string Transaction amount. Excludes currency, symbols, thousands separators. Income uses + + ; expense uses - - .Empty string if amount not visible/unrecognizable. -300.00
party string Counterparty name. Only clearly visible names extracted. Empty string if no clear counterparty. MUHAMMAD ANAS TAQI
balance string Post-transaction balance. Excludes currency/symbols; empty string if not visible/unrecognizable. 112520.83

# 5.2.34 builtin-i88oDw1H2dbkpAXzJ3

Field Name Type Description Example
name string English name, as on card Mr. Meenoy Koyruk
thaiName string Thai name, as on card นาย หมีน้อย คอยรัก
idNo string Thai national ID, 13 digits 0123456789101
bDate string Date of birth 1980-01-14
gender string Gender, standardized M / F
address string Address, full Thai address returned as on the card 2300 คาโลรามา วอชิงตัน ดี.ซี. 20007
issueDate string ID issue date 2023-01-02
expiryDate string ID expiry, date or LIFELONG 2032-01-01 / LIFELONG

# 5.2.35 builtin-rZugtolMwF7J6nkux6

Field Name Type Description Example
ID object Visual zone recognition result -
+no string National ID number (NUIP) 1.000.000.000
+sur string Surname (Apellidos) CASAS RUBIANO
+given string Given name (Nombres) DANIELA
+dob string Date of birth 2000-12-11
+sex string Gender M / F
+pob string Place of birth(Lugar de nacimiento) CARTAGENA (BOLIVAR)
+poi string Place of issue (Lugar de expedición) CARTAGENA
+iss string Issue date 2019-01-16
+exp string Validity 2033-02-26
MRZ object MRZ recognition result -
+docno string MRZ document number 000000012
+dob string MRZ date of birth 1988-08-21
+sex string MRZ gender M / F
+exp string MRZ expiry 2031-01-30
+fname string MRZ parsed full name CASAS RUBIANO DANIELA

# 5.2.36 builtin-TrAXBLVnyyKJQdar1e

Field Name Type Description Example
front object Front side recognition -
+dni string ID number (DNI) 47973966
+surname1 string First surname (paternal) SANCHEZ
+surname2 string Second surname (maternal) HUAPAYA
+names string Given name(s) ESTEPHANI ELIZABETH
+birthDate string Date of birth 1993-08-27
+birthUbigeo string Birth UBIGEO code 140133
+sex string Gender, F=female, M=male F
+marital string Marital status S
+regDate string Registration date 2010-11-10
+issueDate string Document issue date 2023-02-23
+expDate string Document validity 2031-02-23
back object Back side recognition -
+dept string Department LIMA
+prov string Province LIMA
+dist string District SANTIAGO DE SURCO
+addr string Residential address MZ.C LT.18 ASOC. DE VIV SAN JOSE
+level string Registration level code 140130
+organ string Organ donation consent SI / NO
+voteGrp string Voting group code 257530

# 5.2.37 builtin-hra6Eb3IJsMuusbPfH

Field Name Type Description Example
aigc object AI-generated image detection result -
+score number AI risk score, range 0.00 - 1.00.higher score = higher AI-generation risk 0.68
+risk string AI generation risk level. Enum values: no risk, low risk, medium risk, high risk. Risk thresholds: no risk(score ≤ 0.22); low risk(0.22 < score ≤ 0.52); medium risk(0.52 < score ≤ 0.82); high risk(score > 0.82) medium risk
ps object Image tampering detection result -
+is_tampered boolean Whether tampering detected. true means tampering detected, false means no tampering true
+tampered_positions array Detected tampered region coordinates. Each element is a rect region, 8 numbers for 4 corner coords: [top-left x₁, top-left y₁, top-right x₂, top-right y₂, bottom-right x₃, bottom-right y₃, bottom-left x₄, bottom-left y₄]. Multiple regions as multiple arrays; empty array when no tampering [] [[946,775,1038,775,1038,792,946,792]]

# 5.2.37 Ecuador ID Card builtin-EJdRAGeuyPLAG6qv8I

Field Name Type Card Side Description Example
name string front Cardholder full name(Surname+Given name) VIZUETE VIZUETE ANGEL HERIBER
surname string front Surname VIZUETE VIZUETE
givenName string front Given name ANGEL HERIBER
no string front Document number(Document Number) 091787689-8
nui string front Unique identification number(NUI) 1719142905
nationality string front Nationality ECUATORIANA
gender string front Gender M / F
dob string front Date of birth(YYYY-MM-DD) 1993-01-19
pob string front Place of birth CHIMBORAZO RIOBAMBA
expiryDate string front Document validity(YYYY-MM-DD) 2031-12-08
issueDate string Back Document issue date(YYYY-MM-DD) 2021-12-08
issuePlace string Back Document place of issue RIOBAMBA
father string Back Father's name VIZUETE VIDAL
mother string Back Mother's name VIZUETE MARIA
spouse string Back Spouse or cohabiting partner name LARA RUIZ MARIA MAGDALENA
maritalStatus string Back Marital status CASADO
isCard string - Whether it is an Ecuadorian ID card true/false
mrz object MRZ Machine-readable zone(MRZ) recognition result -
+no string MRZ MRZ document number 017836244
+nationality string MRZ MRZ nationality(three-letter code) ECU
+dob string MRZ MRZ date of birth(YYYY-MM-DD) 1993-01-19
+gender string MRZ MRZ gender M / F
+expiryDate string MRZ MRZ expiry(YYYY-MM-DD) 2031-12-08
+surname string MRZ MRZ Surname VIZUETE VIZUETE
+givenName string MRZ MRZ Given name ANGEL HERIBER

# 5.2.38 Malaysia ID Card builtin-5DgJZFnVtvqKdKy2rW

Field Type Description Example
no string IC number (MyKad number) 460619-12-5087
dob string Date of birth (YYYY-MM-DD) 1946-06-19
name string Full name ABD RAUF BIN HAMSAH
gender string Gender; M for male, F for female M
address string Address P O BOX 42, 89007 KENINGAU, SABAH
nationality string Nationality / citizenship WARGANEGARA
religion string Religion ISLAM
issuer string Issuing authority KETUA PENGARAH PENDAFTARAN NEGARA

# 6 Error Codes

HTTP Status Error Message Description
400 BAD_ARGUMENTS: A parameter failed to parse (e.g. BAD_ARGUMENTS:app_id, passing a non-existent app_id).
400 FILE_PARSE_FAILED: File download phase failed.
400 FILE_EXTRACT_FAILED: File recognition phase failed.
400 INVALID_INPUTS_PARAM: The custom inputs field format is invalid.
400 FILE_TOO_LARGE File exceeds the size limit; recommended within 9 MB.
400 FILE_UNSUPPORTED_FORMAT Unsupported file format.
400 TOO_MANY_FILES More files passed in the input than actually supported.
400 MISSING_ARGUMENTS: A required parameter is missing.
400 KEY_NOT_FOUND encryption_type has encryption enabled, but the encryption public key and decryption private key are not configured.
403 AUTHENTICATION_ERROR api_key and api_secret do not match.
403 AUTHORIZATION_ERROR: api_key is disabled, call limit exceeded, no permission to call this API, or no permission to call this API with the current method. Values: "DENIED.": api_key has no permission or is disabled; "Limit reached.": this api_key has reached its call limit for this API.
403 CONCURRENCY_LIMIT_EXCEEDED Concurrency limit exceeded.
403 AUTHENTICATION_ERROR: NO_APP_PERMISSION No app invocation permission.
404 API_NOT_FOUND The API endpoint being called does not exist.
500 INTERNAL_ERROR Internal server error. When this occurs, retry the request. If it persists, contact FaceID customer service or business representative promptly.

# 7 Billing Logic

Billing occurs (or trial usage is deducted) when HTTP status_code=200 and the pages field in the returned data is non-empty.

# 8 Response Example

# General Passport

{
  "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
      }
    }
  }
}

# Image Quality Test

{
  "request_id": "b3d6f9c2-5a8e-4b1f-9d4c-7f2e6a9b3c4d",
  "time_used": 388,
  "pages": 1,
  "result": {
    "outputs": {
      "text": {
        "quality": 1,
        "issues": ["1", "3"]
      }
    }
  }
}

# Fail Response Example

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