Skip to main content

Passenger Info (PaxInfo) Object

Common passenger information structure used across multiple flight API endpoints.


PaxInfo Object Structure

FieldTypeRequiredDescription
indexintegerNoPassenger sequence number
passengerIdstringNoPassenger ID from Retrieve Booking response
givenNamestringYesGiven and middle name
surnamestringYesSurname
typestringYesPassenger type: ADT, CHD, INF
genderbooleanNoGender (true: male, false: female)
dateOfBirthstringConditionalRequired when passenger type is CHD or INF. Date of birth (YYYY-MM-DD)
parentIdintegerNoAdult passenger index or ID that the infant/child accompanies
titlestringNoTitle (MR, MRS, MS, MSTR)
phonestringNoContact phone
emailstringNoContact email
documentobjectNoDocument info (see Document below)
seatMapsarrayNoSelected seat values attached to the passenger
baggagesarrayNoSelected baggage values attached to the passenger
ancillariesarrayNoSelected ancillary service values attached to the passenger
membershipobjectNoMembership info (see Membership below)

Membership Object

FieldTypeRequiredDescription
airlinestringNoAirline code
membershipIdstringNoMembership ID
levelstringNoMembership level
skyTeamLevelstringNoSkyTeam level

Document Object

FieldTypeRequiredDescription
surNamestringConditionalRequired when document is provided. Surname as shown on the document
givenNamestringConditionalRequired when document is provided. Given name as shown on the document
dateOfBirthstringConditionalRequired when the passenger type is CHD or INF. Date of birth (YYYY-MM-DD)
genderbooleanNoGender (true: male, false: female)
numberstringConditionalRequired when document is provided. Document number (max 15 chars)
typestringConditionalRequired when document is provided. Document type: P (passport), I (ID card)
nationalstringNoNationality (3 chars)
expiryDatestringConditionalRequired when document is provided, except when type = I. Expiry date (YYYY-MM-DD)
issueCountrystringNoCountry of issue (3 chars)
issueDatestringNoIssue date (YYYY-MM-DD)

Business Rules

  • type must be one of: ADT, CHD, INF
  • For infants (INF), parentId must reference a valid adult passenger
  • Passenger dateOfBirth is required when type is CHD or INF.
  • Document dateOfBirth is required when document information is submitted for a CHD or INF passenger.
  • If document is provided, type (DocumentType), number, surName, givenName, and expiryDate are required.
  • If document.type is I, expiryDate is optional.
  • When 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",
"type": "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": {
"surName": "NGUYEN",
"givenName": "MINH",
"number": "C1234567",
"type": "P",
"national": "VNM",
"expiryDate": "2030-01-01",
"issueCountry": "VNM",
"issueDate": "2020-01-01"
}
}