API Guide
  1. Vietnam
API Guide
  • Get Started
  • Document AI
    • Malaysia
      • Extract Bank Statement Data
      • Extract Bill of Lading Data
      • Extract Business Card Data
      • Extract Car Meter Data
      • Extract Cheque (Front) Data
      • Extract Company Financial Statement Data
      • Extract Resume Data
      • Extract E-Invoice Data
      • Extract Electricity Bill Data
      • Extract Identity Card Data
      • Extract Invoice Data
      • Extract Passport Data
      • Extract Payslip Data
      • Extract Price Tag Data
      • Extract Purchase Order Data
      • Extract Receipt (General) Data
      • Extract SSM Documents Data
      • Extract Water Bill Data
    • Thailand
      • Extract Business Card Data
      • Extract Identity Card Data
      • Extract Passport Data
      • Extract Receipt Data
    • Vietnam
      • Extract Business Card Data
        POST
      • Extract Identity Card Data
        POST
      • Extract Passport Data
        POST
      • Extract Receipt Data
        POST
    • Philippines
      • Extract Business Card Data
      • Extract Identity Card Data
      • Extract Passport Data
      • Extract Receipt Data
  1. Vietnam

Extract Passport Data

POST
/document-ai/{model-id}

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 NameVariable Type
passport_typestring | null
passport_country_codestring | null
passport_numberstring | null
passport_holder_fullnamestring | null
passport_holder_nationalitystring | null
passport_holder_nationality_vietnamesestring | null
passport_holder_date_of_birthstring | null
passport_holder_place_of_birthstring | null
passport_holder_sexstring | null
passport_holder_sex_vietnamesestring | null
passport_holder_identity_numberstring | null
passport_date_of_issuestring | null
passport_date_of_expirystring | null
passport_place_of_issuestring | 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

Authorization
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
Path Params
model-id
string 
required
To utilize the Axtraction AI API effectively, you must specify a model ID in your requests. The model ID follows the format model- followed by a 12-characters numbers and alphabet. This ID identifies the specific AI model you want to use for document processing.
If you do not have a model yet, you can create one by visiting the Axtraction AI web app. There, you can set up your model according to your requirements and obtain the corresponding model ID for your API requests.
Example:
model-a1b2c3d4e5f6
Body Params multipart/form-data
file
file 
optional
If fileBase64 is not provided, then file is required. Format: PDF, JPEG, PNG.
fileBase64
string 
optional
If file is not provided, then fileBase64 is required. If both file and fileBase64 are provided, only file will be used.
Example:
JVBERi0xLjMNCiXi48/....
mimeType
string 
optional
Required only when fileBase64 is provided. Supported: application/pdf, image/jpeg, image/jpg, image/png.
Example:
application/pdf

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.axtraction.ai/v1/document/document-ai/model-a1b2c3d4e5f6' \
--header 'X-API-KEY;' \
--form 'file=@""' \
--form 'fileBase64="JVBERi0xLjMNCiXi48/...."' \
--form 'mimeType="application/pdf"'

Responses

🟢200Success
application/json
Body
success
boolean 
required
data
array [object {2}] 
required
type
string 
required
value
string  | null 
required
miscellaneous
object 
required
processedTime
number 
required
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
    }
}
Modified at 2025-05-13 04:16:04
Previous
Extract Identity Card Data
Next
Extract Receipt Data
Built with