type_of_id

The type of document

String, "passport"

surname

Surname or family name of the holder

String, Variable length in latin script

given_name

Given names of the holder

String, Variable length in latin script

surname_non_latin

Surname or family name of the holder in non-latin script

String, Variable length in non-latin script

given_name_non_latin

Given name of the holder in non-latin script

String, Variable length in non-latin script

type

Passport type

String, Variable length

country_code

Country code

String, Variable length

passport_number

Passport number

String, Variable length

personal_number

Personal identification number given to holder by the issuing State or organization.

String, Variable length e.g. HKID number: A123456(7)

nationality_alpha_3

Nationality of the passport holder as listed in MRZ. It follows the standard of ISO 3166 alpha 3 with modification.

String, 1-3 characters

nationality

A conversion of nationality_alpha_3to its English counterparts by FormX

String, Variable length

sex

Sex or gender of the holder

M, F, or X

date_of_birth

Date of birth of the holder

YYYY-MM-DD or YYYY-MM or YYYY

date_of_expiry

Expiry date of the document

YYYY-MM-DD

place_of_birth

City or State of the holder’s birthplace

String, Variable length

portrait

The bounding box of the portrait of the holder

Array oduction

For

signature

The bounding box of the signature of the holder

Array oduction

For

mrz_upper_line

The upper line of MRZ

String, Variable length

mrz_lower_line

The second line of MRZ

String, Variable length

mrz_validation

Validation results of a series of checking done by FormX to validate the information extracted from MRZ.

Dictionary with validation items in boolean. An example:\

{  
  "is_passport_number_valid": true,  
  "is_date_of_birth_valid": true,  
  "is_date_of_expiry_valid": true,  
  "is_personal_number_valid": true,  
  "is_composite_check_digit_valid": true  
}

type_of_id

The type of document

String, "id.hkg"

chinese_commercial_code

A numeric or alphanumeric code used for administrative identification in Hong Kong

String, variable length

name

Full name of the holder

String, variable length

name_non_latin

Name of the holder in non-Latin script

String, variable length

is_permanent_resident

Permanent resident status

Boolean

sex

Sex or gender of the holder

M, F, or X

date_of_birth

Date of birth of the holder

String, YYYY-MM-DD

date_of_issue

Issue date of the document

String, YYYY-MM-DD

personal_number

Personal identification number

String, variable length

portrait

Portrait photo

String
If a portrait photo is detected, value "portrait" will be returned

type_of_id

The type of document

String, "id.mac"

given_name

Given name of the holder

String, variable length

given_name_non_latin

Given name of the holder in non-Latin script

String, variable length

chin_commercial_code_given_names

Chinese commercial code for given names

String, variable length

date_of_birth

Date of birth of the holder

String, YYYY-MM-DD

surname

Surname/Family name of the holder

String, variable length

surname_non_latin

Surname/Family name of the holder in non-Latin script

String, variable length

chin_commercial_code_surname

Chinese commercial code for surname

String, variable length

is_permanent_resident

Permanent resident status

Boolean

sex

Sex or gender of the holder (M, F, X)

M, F, or X

date_of_expiry

Expiry date of the document

String, YYYY-MM-DD

date_of_issue

Issue date of the document

String, YYYY-MM-DD

date_of_first_issue

Date of first issue of the document

String, YYYY-MM-DD

height

Height of the holder in meters

Float

personal_number

Personal identification number

String, variable length

signature

Signature of the holder

String
If a signature is detected, value "signature" will be returned

portrait

Portrait photo

String
If a portrait photo is detected, value "portrait" will be returned

type_of_id

The type of document

String, id.twn

name

Full name of the holder

String, variable length

date_of_birth

Date of birth of the holder

String, YYYY-MM-DD

personal_number

Personal identification number

String, variable length

sex

Sex or gender of the holder

M, F, or X

date_of_issue

Issue date of the document

String, YYYY-MM-DD

portrait

Portrait photo

String
If a portrait photo is detected, value "portrait" will be returned

type_of_id

The type of document

String, "id.tha"

form_type

Specific form type of the document

String, "thai_national_id_card"

personal_number

Personal identification number

String, variable length

request_number

Request number associated with the ID

String, variable length

name_non_latin

Full name of the holder in non-Latin script

String, variable length

given_name

Given name of the holder

String, variable length

surname

Surname of the holder

String, variable length

date_of_birth

Date of birth of the holder

String, YYYY-MM-DD

religion

Religion of the holder

String, variable length

address

Residential address of the holder

String, variable length

date_of_issue

Issue date of the document

String, YYYY-MM-DD

date_of_expiry

Expiry date of the document

String, YYYY-MM-DD

portrait

Portrait photo

String
If a portrait photo is detected, value "portrait" will be returned

signature

Signature of the holder

String
If a portrait photo is detected, value "signature" will be returned