TUI Group Booking/checkin API

openapi: 3.2.0
info:
  title: NewSkies-Digital-Api Booking/checkin API
  version: 4.8.6.23
  description: Navitaire Digital Api
servers:
- url: https://prod.api.tui/flight/newskies/rest
  description: TUI Prod
- url: https://playground.api.tui/flight/newskies/rest
  description: TUI Playground
security:
- JWT: []
tags:
- name: booking/checkin
paths:
  /api/nsk/v1/booking/checkin/journey/{journeyKey}:
    delete:
      tags:
      - booking/checkin
      summary: Removes the checkin status of passengers for a specific journey in state.
      description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.`


        GraphQL endpoint: checkinByJourneyDelete'
      operationId: nsk_v1_booking_checkin_journey_journeyKey_delete
      parameters:
      - name: journeyKey
        in: path
        required: true
        description: The journey key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The checkin passengers request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckinPassengersRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v3/booking/checkin/journey/{journeyKey}:
    post:
      tags:
      - booking/checkin
      summary: Checks in a collection of passengers to a specific journey in state.
      description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.`

        - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages`

        is set to true.

        - When debug mode is disabled, warning and error messages will be returned to agents only if the

        `SystemOptions.HideErrorMessages` is set to false.


        GraphQL endpoint: checkinByJourneyAddv3'
      operationId: nsk_v3_booking_checkin_journey_journeyKey_post
      parameters:
      - name: journeyKey
        in: path
        required: true
        description: The journey key of the segments to checkin.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The checkin passengers request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckinPassengersRequestv3'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Check-in Successful:
                  description: Example when check-in is successful.
                  value:
                    data: null
                Checkin Valid with displaying warning message to agents.:
                  description: Example message when check in requirements are met, but there are still travel documents required.  This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off.
                  value:
                    messages:
                    - code: CheckinPassengerWarning
                      type: Warning
                      value: 'AUT TEST Authorization Response Free Text

                        8501:AU:OK TO BOARD

                        Documents are required for this flight.'
                      status: 0
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_
                    data: null
                Checkin Valid with a masked warning message.:
                  description: Example message when check in requirements are met, but there are still travel documents required.  This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown.
                  value:
                    messages:
                    - code: CheckinPassengerWarning
                      type: Warning
                      value: CheckinPassengerWarning
                      status: 0
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_
                    data: null
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Checkin Invalid:
                  description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:Invalid
                      message: nsk:Checkin:Invalid
                      type: Validation
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Seat Missing:
                  description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:TypeID:1223
                      message: nsk:Checkin:TypeID:1223
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Inhibited:
                  description: In this example the passenger meets all the requirements but is inhibited due to government security.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:TypeID:3096
                      message: nsk:Checkin:TypeID:3096
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: nsk:Checkin:TypeID:3088
                      message: nsk:Checkin:TypeID:3088
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Missing verified document with agent visible error message:
                  description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly.  This is an example response when debug mode is turned off.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:TypeID:1236
                      message: Baggins/Bilbo missing verified documents.
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v2/booking/checkin/journey/{journeyKey}/requirements:
    get:
      tags:
      - booking/checkin
      summary: Gets the checkin pre-validation requirements for a specific journey.
      description: 'GraphQL endpoint: checkinByJourneyRequirementsv2'
      operationId: nsk_v2_booking_checkin_journey_journeyKey_requirements_get
      parameters:
      - name: journeyKey
        in: path
        required: true
        description: The journey key to be pre validate checkin with.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2'
              examples:
                Valid Response No Restrictions:
                  description: Example Response
                  value:
                    data:
                      passengers:
                        passengerKey:
                          passengerKey: PassengerKey
                          documentRequirements:
                            documentsOnFile:
                            - P
                            - V
                            governmentDocumentInstances:
                            - governmentInstance: USDHS
                              numberOfMissingDocuments: 0
                              eligibleDocuments:
                              - group: 18
                                documentTypeCode: I
                              - group: 5
                                documentTypeCode: M
                              verifiableDocuments:
                              - group: 6
                                documentTypeCode: P
                              - group: 9
                                documentTypeCode: V
                              documentVerificationRequired: true
                            - governmentInstance: CBSA
                              numberOfMissingDocuments: 0
                              eligibleDocuments:
                              - group: 18
                                documentTypeCode: I
                              verifiableDocuments:
                              - group: 6
                                documentTypeCode: P
                              - group: 9
                                documentTypeCode: V
                              documentVerificationRequired: true
                            isValid: true
                          addressRequirements:
                            isValid: false
                            addressesOnFile:
                            - Address1
                            unhandledAddresses:
                            - Address2
                          invalidSsrs: null
                          requiredSsrs: null
                          restrictions: null
                          isValid: true
                      governmentProgramRequirements:
                        usdhs:
                          governmentInstance: null
                          requiredDocumentFields: null
                          additionalDataRequired: null
                          programDescription: USDHS
                          messageType: null
                          minVerifiedDocumentCount: 1
                        cbsa:
                          governmentInstance: null
                          requiredDocumentFields: null
                          additionalDataRequired: null
                          programDescription: CBSA
                          messageType: null
                          minVerifiedDocumentCount: 1
                      restrictions: null
                      isValid: true
                Response with Restrictions:
                  description: Example Response
                  value:
                    data:
                      passengers:
                        passengerKey:
                          passengerKey: PassengerKey
                          documentRequirements: null
                          addressRequirements: null
                          invalidSsrs: null
                          requiredSsrs: null
                          restrictions:
                          - restriction: 12
                            description: Missing Documents
                          - restriction: 1
                            description: Missing Destination Address
                          isValid: false
                      governmentProgramRequirements:
                        usdhs:
                          governmentInstance: null
                          requiredDocumentFields: null
                          additionalDataRequired: null
                          programDescription: USDHS
                          messageType: null
                          minVerifiedDocumentCount: 1
                      restrictions:
                      - 4
                      isValid: false
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/booking/checkin/journey/{journeyKey}/requirements:
    get:
      tags:
      - booking/checkin
      summary: Gets the checkin pre-validation requirements for a specific journey.
      description: 'GraphQL endpoint: checkinByJourneyRequirements'
      operationId: nsk_v1_booking_checkin_journey_journeyKey_requirements_get
      parameters:
      - name: journeyKey
        in: path
        required: true
        description: The journey key to be pre validate checkin with.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfCheckinRequirements'
              examples:
                Not Paid In Full:
                  description: Example partial response showing that the payment is due before check in
                  value:
                    data:
                      isValid: false
                      passengers: null
                      governmentProgramRequirements: null
                      restrictions:
                      - 4
                Closed:
                  description: Example partial response showing that the check in is closed which is common if its outside of the configured check in window.
                  value:
                    data:
                      isValid: false
                      passengers: null
                      governmentProgramRequirements: null
                      restrictions:
                      - 0
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
      deprecated: true
  /api/nsk/v1/booking/checkin/journey/{journeyKey}/status:
    get:
      tags:
      - booking/checkin
      summary: Gets the passengers lift status for a specific journey based on the booking in state.
      description: 'GraphQL endpoint: checkinByJourneyStatus'
      operationId: nsk_v1_booking_checkin_journey_journeyKey_status_get
      parameters:
      - name: journeyKey
        in: path
        required: true
        description: The journey to check lift statuses.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIDictionaryOfStringAndIListOfCheckinPassengerLiftStatus'
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/booking/checkin/segment/{segmentKey}:
    delete:
      tags:
      - booking/checkin
      summary: Removes the checkin status of passengers for a specific journey's segment in state.
      description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.`


        GraphQL endpoint: checkinBySegmentDelete'
      operationId: nsk_v1_booking_checkin_segment_segmentKey_delete
      parameters:
      - name: segmentKey
        in: path
        required: true
        description: The segment key.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The checkin passengers request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckinPassengersRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v3/booking/checkin/segment/{segmentKey}:
    post:
      tags:
      - booking/checkin
      summary: Checks in a collection of passengers to a specific journey's segment in state.
      description: '`IMPORTANT: This endpoint should NOT be called concurrently using the same session token to avoid performance

        problems.`

        - When debug mode is disabled, warning and error messages will be masked if the `SystemOptions.HideErrorMessages`

        is set to true.

        - When debug mode is disabled, warning and error messages will be returned to agents only if the

        `SystemOptions.HideErrorMessages` is set to false.


        GraphQL endpoint: checkinBySegmentAddv3'
      operationId: nsk_v3_booking_checkin_segment_segmentKey_post
      parameters:
      - name: segmentKey
        in: path
        required: true
        description: The segment key of the segment to checkin.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The checkin passengers request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckinPassengersRequestv3'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Check-in Successful:
                  description: Example when check-in is successful.
                  value:
                    data: null
                Checkin Valid with displaying warning message to agents.:
                  description: Example message when check in requirements are met, but there are still travel documents required.  This requires Digital API configuration to be set such that warning messages can be returned to agents only when debug is turned off.
                  value:
                    messages:
                    - code: CheckinPassengerWarning
                      type: Warning
                      value: 'AUT TEST Authorization Response Free Text

                        8501:AU:OK TO BOARD

                        Documents are required for this flight.'
                      status: 0
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_
                    data: null
                Checkin Valid with a masked warning message.:
                  description: Example message when check in requirements are met, but there are still travel documents required.  This is what non-agents will see regardless of Digital API configuration for displaying warning messages when debug is off.This is also what an agent would see if the corresponding API configuration is not set to allow warning messages to be shown.
                  value:
                    messages:
                    - code: CheckinPassengerWarning
                      type: Warning
                      value: CheckinPassengerWarning
                      status: 0
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTYzMH4gfn5CTkV_MDgvMjEvMjAyNCAwOTowMH5TWUR_MDgvMjEvMjAyNCAxMjowMH5_
                    data: null
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Checkin Invalid:
                  description: Example error when check in requirements are not met. The /requirements endpoint should be called before attempting a checkin.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:Invalid
                      message: nsk:Checkin:Invalid
                      type: Validation
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: Checkin request is invalid. Please refer to checkin requirements for more details.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Seat Missing:
                  description: In this example the optional request parameter `seatsRequired` was set to true. One passenger had a seat assigned and one did not.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:TypeID:1223
                      message: nsk:Checkin:TypeID:1223
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: Baggins/Bilbo missing seat assignments on flight number 2452.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Inhibited:
                  description: In this example the passenger meets all the requirements but is inhibited due to government security.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:TypeID:3096
                      message: nsk:Checkin:TypeID:3096
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    - id: null
                      code: nsk:Checkin:TypeID:3088
                      message: nsk:Checkin:TypeID:3088
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: 'United States - SecureFlight: Passenger inhibited from checkin. CONTACT THE DHS RESOLUTION DESK AT: 1-800-CALL-DHS\nAUT TEST Authorization Response Free Text\n'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Missing verified document with agent visible error message:
                  description: This example shows both the expected response when a passenger is missing verified documents, as well as what a logged-in agent would see if the API configuration is set correctly.  This is an example response when debug mode is turned off.
                  value:
                    errors:
                    - id: null
                      code: nsk:Checkin:TypeID:1236
                      message: Baggins/Bilbo missing verified documents.
                      type: Error
                      details:
                        passengerKey: MCFBRFQ-
                        segmentKey: TlZ_NTY1NX4gfn5TTEN_MDkvMDYvMjAyNCAwOTowMH5NTkx_MDkvMDcvMjAyNCAwNTowMH5_
                      rawMessage: null
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
        '409':
          description: Concurrent changes were being made in the same session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v2/booking/checkin/segment/{segmentKey}/requirements:
    get:
      tags:
      - booking/checkin
      summary: Gets the checkin pre-validation requirements for a specific journey's segment.
      description: 'GraphQL endpoint: checkinBySegmentRequirementsv2'
      operationId: nsk_v2_booking_checkin_segment_segmentKey_requirements_get
      parameters:
      - name: segmentKey
        in: path
        required: true
        description: The segment key to pre validate checkin with.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfCheckinRequirementsv2'
              examples:
                Valid Response No Restrictions:
                  description: Example Response
                  value:
                    data:
                      passengers:
                        passengerKey:
                          passengerKey: PassengerKey
                          documentRequirements:
                            documentsOnFile:
                            - P
                            - V
                            governmentDocumentInstances:
                            - governmentInstance: USDHS
                              numberOfMissingDocuments: 0
                              eligibleDocuments:
                              - group: 18
                                documentTypeCode: I
                              - group: 5
                                documentTypeCode: M
                              verifiableDocuments:
                              - group: 6
                                documentTypeCode: P
                              - group: 9
                                documentTypeCode: V
                              documentVerificationRequired: true
                            - governmentInstance: CBSA
                              numberOfMissingDocuments: 0
                              eligibleDocuments:
                              - group: 18
                                documentTypeCode: I
                              verifiableDocuments:
                              - group: 6
                                documentTypeCode: P
                              - group: 9
                                documentTypeCode: V
                              documentVerificationRequired: true
                            isValid: true
                          addressRequirements:
                            isValid: false
                            addressesOnFile:
                            - Address1
                            unhandledAddresses:
                            - Address2
                          invalidSsrs: null
                          requiredSsrs: null
                          restrictions: null
                          isValid: true
                      governmentProgramRequirements:
                        usdhs:
                          governmentInstance: null
                          requiredDocumentFields: null
                          additionalDataRequired: null
                          programDescription: USDHS
                          messageType: null
                          minVerifiedDocumentCount: 1
                        cbsa:
                          governmentInstance: null
                          requiredDocumentFields: null
                          additionalDataRequired: null
                          programDescription: CBSA
                          messageType: null
                          minVerifiedDocumentCount: 1
                      restrictions: null
                      isValid: true
                Response with Restrictions:
             

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tui-group/refs/heads/main/openapi/tui-group-booking-checkin-api-openapi.yml