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_no`	string \| null
`passport_surname`	string \| null
`passport_given_name`	string \| null
`passport_middle_name`	string \| null
`passport_date_of_birth`	string \| null
`passport_nationality`	string \| null
`passport_sex`	string \| null
`passport_place_of_birth`	string \| null
`passport_date_of_issue`	string \| null
`passport_valid_until`	string \| null
`passport_issuing_authority`	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": "P"
        },
        {
            "type": "passport_country_code",
            "value": "PHL"
        },
        {
            "type": "passport_no",
            "value": "P0000000A"
        },
        {
            "type": "passport_surname",
            "value": "DELA CRUZ"
        },
        {
            "type": "passport_given_name",
            "value": "MARIA"
        },
        {
            "type": "passport_middle_name",
            "value": "SANTOS"
        },
        {
            "type": "passport_date_of_birth",
            "value": "16 MAR 1980"
        },
        {
            "type": "passport_nationality",
            "value": "FILIPINO"
        },
        {
            "type": "passport_sex",
            "value": "F"
        },
        {
            "type": "passport_place_of_birth",
            "value": "MANILA"
        },
        {
            "type": "passport_date_of_issue",
            "value": "27 JUN 2016"
        },
        {
            "type": "passport_valid_until",
            "value": "26 JUN 2021"
        },
        {
            "type": "passport_issuing_authority",
            "value": "DFA MANILA"
        }
    ],
    "miscellaneous": {
        "processedTime": 102.456
    }
}

Extract Passport Data

Extracted Data Types#

Notes#

Request

Request samples

Responses

Extracted Data Types

Notes