Extract Passport Data

Extracted Data Types

The following types will always be present in the API response. If a type parameter is not found in the input, its value will be null.

Parameter Name	Variable Type
`passport_type`	string \| null
`passport_country_code`	string \| null
`passport_number`	string \| null
`passport_holder_fullname`	string \| null
`passport_holder_nationality`	string \| null
`passport_holder_nationality_vietnamese`	string \| null
`passport_holder_date_of_birth`	string \| null
`passport_holder_place_of_birth`	string \| null
`passport_holder_sex`	string \| null
`passport_holder_sex_vietnamese`	string \| null
`passport_holder_identity_number`	string \| null
`passport_date_of_issue`	string \| null
`passport_date_of_expiry`	string \| null
`passport_place_of_issue`	string \| null

Notes

Each type parameter in the data array will always have the specified type, with the possibility of being null.

If a specific type parameter is not present in the input, its value in the response will be null.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "type": "passport_type",
            "value": "Ordinary"
        },
        {
            "type": "passport_country_code",
            "value": "VN"
        },
        {
            "type": "passport_number",
            "value": "A123456789"
        },
        {
            "type": "passport_holder_fullname",
            "value": "Nguyen Van An"
        },
        {
            "type": "passport_holder_nationality",
            "value": "Vietnamese"
        },
        {
            "type": "passport_holder_nationality_vietnamese",
            "value": "Người Việt Nam"
        },
        {
            "type": "passport_holder_date_of_birth",
            "value": "1990-05-15"
        },
        {
            "type": "passport_holder_place_of_birth",
            "value": "Hanoi"
        },
        {
            "type": "passport_holder_sex",
            "value": "Male"
        },
        {
            "type": "passport_holder_sex_vietnamese",
            "value": "Nam"
        },
        {
            "type": "passport_holder_identity_number",
            "value": "123456789"
        },
        {
            "type": "passport_date_of_issue",
            "value": "2020-01-01"
        },
        {
            "type": "passport_date_of_expiry",
            "value": "2030-01-01"
        },
        {
            "type": "passport_place_of_issue",
            "value": "Hanoi Immigration Office"
        }
    ],
    "miscellaneous": {
        "processedTime": 102.456
    }
}

Extract Passport Data

Extracted Data Types#

Notes#

Request

Request samples

Responses

Extracted Data Types

Notes