Skip to main content

Passenger Info (PaxInfo) Object

Common passenger information structure used across multiple flight API endpoints.


PaxInfo Object Structure

FieldTypeRequiredDescription
indexintegerYesSequence number, starting from 1
passengerIdstringNoPassenger ID (from RetrievePNR)
parentIdstringNoAdult passenger ID (for INF - infants only)
passengerTypestringYesPassenger type: ADT (Adult), CHD (Child), INF (Infant)
titlestringNoTitle (MR, MS, MRS, MSTR)
genderbooleanNoGender (true: male, false: female)
givenNamestringYesGiven and middle name
surnamestringYesSurname
dateOfBirthstringNoDate of birth (YYYY-MM-DD, required for CHD/INF)
emailstringNoContact email
phonestringNoContact phone
membershipobjectNoMembership info (see Membership below)
documentobjectNoDocument info (see Document below)

Membership Object

FieldTypeRequiredDescription
airlinestringNoAirline code
membershipIdstringNoMembership ID
levelstringNoMembership level
skyTeamLevelstringNoSkyTeam level

Document Object

FieldTypeRequiredDescription
surNamestringNoSurname (as on document)
givenNamestringNoGiven name (as on document)
dateOfBirthstringNoDate of birth (YYYY-MM-DD)
genderbooleanNoGender (true: male, false: female)
numberstringYesDocument number (max 15 chars)
typestringYesDocument type: P (passport), I (ID card)
nationalstringNoNationality (3 chars)
expiryDatestringYesExpiry date (YYYY-MM-DD)
issueCountrystringYesCountry of issue (3 chars)
issueDatestringNoIssue date (YYYY-MM-DD)

Business Rules

  • passengerType must be one of: ADT, CHD, INF
  • For infants (INF), parentId must reference a valid adult passenger
  • dateOfBirth is required for CHD and INF passenger types
  • Document type and number are required when document info is provided
  • expiryDate must be in the future for document validation
  • Maximum 15 characters for document number

Usage

This object structure is used in the following endpoints:


Example

{
"index": 1,
"passengerId": "PAX001",
"passengerType": "ADT",
"title": "MR",
"gender": true,
"givenName": "MINH",
"surname": "NGUYEN",
"dateOfBirth": "1990-01-01",
"email": "minh@example.com",
"phone": "+84901234567",
"membership": {
"airline": "VN",
"membershipId": "MEM123456",
"level": "GOLD",
"skyTeamLevel": null
},
"document": {
"number": "C1234567",
"type": "P",
"national": "VNM",
"expiryDate": "2030-01-01",
"issueCountry": "VNM",
"issueDate": "2020-01-01"
}
}