Data Fields
This guide lists all the possible data fields that can be extracted from the document and appear in the multiple different API responses under data object.
Data Object Structure
Each data object is identified with a unique Key, under the key there will be an array of objects. If you are only uploading one-sided document, data object will generally contains only 1 item. If you are uploading both front and back of an ID, it is possible that the engine was able to extract the same kind data from both side, resulting in multiple entries.
| Attribute | Datatype | Description |
|---|---|---|
| value | String | The value of the attribute. |
| confidence | Number | This is a probability indicator that ranges from 0 to 1. This indicates how fine the scan has identified the target and is able to retrieve the relevant details. |
| source | String | Indicates the source of how the information is retrieved. E.g., In the case of the scanned case, the source is visually scanned; hence the value will be Visual. Possible values are "visual", "MRZ" or "barcode". - visual means that catch field from id image directly. - MRZ [Machine Readable Zone] means that catch field from MRZ code. |
| index | Integer | This indicates the side of the document. 0=Front 1=Back |
| inputBox | 2-D Jagged Array | Bounding box relative to the uploaded image. This is a yellow line box The array is in order by TopLeft, TopRight, BottomRight, BottomLeft and sorted by x, y. |
| outputBox | 2-D Jagged Array | Bounding box relative to the output & saved image. This is a yellow line box. The array is in order by TopLeft, TopRight, BottomRight, BottomLeft and sorted by x, y. |
Possible Keys
ID Numbers
| Key | Description |
|---|---|
| documentNumber | Unique identifier associated with the document (e.g. Passport No./Driver License No./Card Number etc) |
| personalNumber | Unique personal identifier associated with the person within a country (e.g. National ID Number) |
You may encounter documents with both documentNumber and personalNumber, or only one of the fields.
Names
| Key | Description |
|---|---|
| firstName | First name / Given name |
| middleName | Middle name(s) |
| lastName | Last name / Family name |
| fullName | If the first name and last name cannot be distinguished, full name will be returned instead |
| firstName_local | First name in local language if available |
| middleName_local | Middle name in local language if available |
| lastName_local | Last name in local language if available |
| fullName_local | Full name in local language if available |
Dates
All documentation-related dates will be handled in the below formats. The parameters are trimmed down to individual components to ease the operations.
| Key | Description |
|---|---|
| dob | Date of birth in YYYY/MM/DD |
| dob_day | Date of birth day 1 to 31 |
| dob_month | Date of birth month 1 to 12 |
| dob_year | Date of birth year in YYYY |
| expiry | Expiry date of document in YYYY/MM/DD |
| expiry_day | Day of expiry 1 to 31 |
| expiry_month | Month of expiry 1 to 12 |
| expiry_year | Year of expiry in YYYY |
| issued | Date of issue in YYYY/MM/DD |
| issued_day | Day of issue 1 to 31 |
| issued_month | Month of issue 1 to 12 |
| issued_year | Year of issue in YYYY |
| daysToExpiry | Number of days before the document expires |
| daysFromIssue | Number of days since the document was issued |
Personal Information
| Key | Description |
|---|---|
| age | Age of the document holder |
| sex | Gender M=Male, F=Female, X=Unspecified |
| height | Height of person |
| weight | Weight of person |
| hairColor | Hair Color - ANSI D-20 hair color code (3 letters) |
| eyeColor | Eye Color - ANSI D-20 eye color code (3 letters) |
| address1 | Address line 1 |
| address2 | Address line 2 |
| postcode | Address postcode |
| placeOfBirth | Place of birth |
| religion | Religion |
Document Information
| Key | Description |
|---|---|
| documentSide | Side of the document: FRONT, BACK or BIODATA |
| documentType | Type of document: P=Passport, D=Driver's License, I=Identity Card, V=Visa, R=Residence Card, B=Business Registration, O=Other |
| documentName | If documentType is "O", a document name will be included. |
| stateFull | Document issuer subregion/state. Example: California |
| stateShort | Document issuer subregion/state abbreviation. Example: CA |
| countryFull | Document issued country. Example: United States |
| countryIso2 | Document issued country code in ISO2. Example: US |
| countryIso3 | Document issued country code in ISO3. Example: USA |
| nationalityFull | Document holder nationality. Example: United States |
| nationalityIso2 | Document holder nationality in ISO2. Example: US |
| nationalityIso3 | Document holder nationality in ISO3. Example: USA |
| vehicleClass | Driver license vehicle class |
| restrictions | Driver license restrictions |
| endorsement | Driver license endorsement |
| issueAuthority | Issuer of the document |
| visaType | Type of Visa |
Business Registrations
| Key | Description |
|---|---|
| entityType | Business entity type as shown on the document |
| businessName | Primary business name |
| businessNameLocal | Business in secondary language if available |
| businessRegistrationNumber | Number used to identity the business within the country. |
Other Data
| Key | Description |
|---|---|
| optionalData | Extra unspecific data included in the document |
| optionalData2 | Extra unspecific data included in the document |
| optionalData3 | Extra unspecific data included in the document |
| optionalData4 | Extra unspecific data included in the document |
| internalId | Used to identify the unique document ID under ID Analyzer system, same type of document should have the same ID. |
Object Detection
| Key | Description |
|---|---|
| face | Location of faces on document |
| signature | Location of signatures on document |
| document | Location of document in image |
Uncommon Fields
Below are fields that you may encounter on rare occassions and are specific to certain documents.
// Some documents with family members
parentName
fatherName
motherName
children
grandFather
// Secondary document number on reverse side of some IDs
documentNumber2
// UAE Visa
profession
// UAE ID
sponsor
occupation
employer
// Portugal ID
parentsGivenNames
taxNumber
socialInsuranceNumber
healthInsuranceNumber
// Korean ID/DL back column
column1
// Korean driver license
licenseType
// Taiwan Residence Certificate (ARC)
passportNumber
purpose
// Lesotho vehicle license
licenceNo
registerNo
vin
engineNo
fees
gvm
tare
make
description
// Chinese DL Validity Length (years)
validPeriod
// Zambia ID
village
district
chief
// Ethopia Resident ID
phone1
phone2
// UAE Vehicle License Electronic
model
origin
numOfPass
vehType
GVW
engNo
chassisNo
trafficPlateNo
policyNo
// Japan Residence Card
visaStatus
// UK/EU Driving License
AM(10)
AM(11)
AM(12)
A1(10)
A1(11)
A1(12)
A2(10)
A2(11)
A2(12)
A(10)
A(11)
A(12)
B1(10)
B1(11)
B1(12)
B(10)
B(11)
B(12)
C1(10)
C1(11)
C1(12)
C(10)
C(11)
C(12)
D1(10)
D1(11)
D1(12)
D(10)
D(11)
D(12)
BE(10)
BE(11)
BE(12)
C1E(10)
C1E(11)
C1E(12)
CE(10)
CE(11)
CE(12)
D1E(10)
D1E(11)
D1E(12)
DE(10)
DE(11)
DE(12)
fklnpq(10)
fklnpq(11)
fklnpq(12)
// Bangladesh ID
temporary
// Bahrain Payslip
employeeName
employeeCPR
employmentDay
employmentMonth
employmentYear
salaryMonth
salaryYear
bankIBAN
bankName
basicSalary
deductionTotal
salaryAndBonusTotal
totalNetSalary
totalNetWords
Updated 9 months ago