Amadeus · Schema

IdentityDocument

documents of the traveler

TravelTravel TechnologyReservationsFlightsHotelsAirlinesHospitalityTours and ActivitiesCars and TransfersDestination ContentItinerary ManagementTrip PlanningArtificial IntelligenceMarket Insights
View JSON Schema on GitHub

JSON Schema

flight-order-management-identity-document-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/flight-order-management-identity-document-schema.json",
  "title": "IdentityDocument",
  "description": "documents of the traveler",
  "allOf": [
    {
      "type": "object",
      "description": "the information that are found on an ID document",
      "properties": {
        "number": {
          "type": "string",
          "description": "The document number (shown on the document) . E.g. QFU514563221J",
          "example": 1
        },
        "issuanceDate": {
          "type": "string",
          "description": "Date at which the document has been issued.",
          "format": "date",
          "example": "2026-08-15"
        },
        "expiryDate": {
          "type": "string",
          "description": "Date after which the document is not valid anymore.",
          "format": "date",
          "example": "2026-08-15"
        },
        "issuanceCountry": {
          "type": "string",
          "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country that issued the document",
          "pattern": "[a-zA-Z]{2}",
          "example": 1
        },
        "issuanceLocation": {
          "type": "string",
          "description": "A more precise information concerning the place where the document has been issued, when available. It may be a country, a state, a city or any other type of location. e.g. New-York",
          "example": "string-value"
        },
        "nationality": {
          "type": "string",
          "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the nationality appearing on the document",
          "pattern": "[a-zA-Z]{2}",
          "example": "string-value"
        },
        "birthPlace": {
          "type": "string",
          "description": "Birth place as indicated on the document",
          "example": "string-value"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "documentType": {
          "type": "string",
          "description": "the nature/type of the document",
          "enum": [
            "VISA",
            "PASSPORT",
            "IDENTITY_CARD",
            "KNOWN_TRAVELER",
            "REDRESS"
          ],
          "example": "VISA"
        },
        "validityCountry": {
          "type": "string",
          "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country where the document is valid",
          "example": "IN",
          "pattern": "[a-zA-Z]{2}"
        },
        "birthCountry": {
          "type": "string",
          "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country of birth",
          "example": "FR",
          "pattern": "[a-zA-Z]{2}"
        },
        "holder": {
          "type": "boolean",
          "description": "boolean to specify if the traveler is the holder of the document",
          "example": true
        }
      }
    }
  ]
}