Passenger Info (PaxInfo) Object
Common passenger information structure used across multiple flight API endpoints.
PaxInfo Object Structure
| Field | Type | Required | Description |
|---|---|---|---|
| index | integer | No | Passenger sequence number |
| passengerId | string | No | Passenger ID from Retrieve Booking response |
| givenName | string | Yes | Given and middle name |
| surname | string | Yes | Surname |
| type | string | Yes | Passenger type: ADT, CHD, INF |
| gender | boolean | No | Gender (true: male, false: female) |
| dateOfBirth | string | Conditional | Required when passenger type is CHD or INF. Date of birth (YYYY-MM-DD) |
| parentId | integer | No | Adult passenger index or ID that the infant/child accompanies |
| title | string | No | Title (MR, MRS, MS, MSTR) |
| phone | string | No | Contact phone |
| string | No | Contact email | |
| document | object | No | Document info (see Document below) |
| seatMaps | array | No | Selected seat values attached to the passenger |
| baggages | array | No | Selected baggage values attached to the passenger |
| ancillaries | array | No | Selected ancillary service values attached to the passenger |
| membership | object | No | Membership info (see Membership below) |
Membership Object
| Field | Type | Required | Description |
|---|---|---|---|
| airline | string | No | Airline code |
| membershipId | string | No | Membership ID |
| level | string | No | Membership level |
| skyTeamLevel | string | No | SkyTeam level |
Document Object
| Field | Type | Required | Description |
|---|---|---|---|
| surName | string | Conditional | Required when document is provided. Surname as shown on the document |
| givenName | string | Conditional | Required when document is provided. Given name as shown on the document |
| dateOfBirth | string | Conditional | Required when the passenger type is CHD or INF. Date of birth (YYYY-MM-DD) |
| gender | boolean | No | Gender (true: male, false: female) |
| number | string | Conditional | Required when document is provided. Document number (max 15 chars) |
| type | string | Conditional | Required when document is provided. Document type: P (passport), I (ID card) |
| national | string | No | Nationality (3 chars) |
| expiryDate | string | Conditional | Required when document is provided, except when type = I. Expiry date (YYYY-MM-DD) |
| issueCountry | string | No | Country of issue (3 chars) |
| issueDate | string | No | Issue date (YYYY-MM-DD) |
Business Rules
typemust be one of: ADT, CHD, INF- For infants (INF),
parentIdmust reference a valid adult passenger - Passenger
dateOfBirthis required whentypeisCHDorINF. - Document
dateOfBirthis required when document information is submitted for aCHDorINFpassenger. - If
documentis provided,type(DocumentType),number,surName,givenName, andexpiryDateare required. - If
document.typeisI,expiryDateis optional. - When provided,
expiryDatemust 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"
}
}