Saved Successfully.
On this page
 

Amend APIS Info Flow

This flow demonstrates the end-to-end process for performing an Amend APIS (Advanced Passenger Information System) operation. The Amend APIS function allows customers or agents to update or correct passenger identity information associated with an existing booking — such as passport details, nationality, or date of birth. This ensures compliance with government travel requirements and enables accurate transmission of passenger data to border control authorities prior to departure.

The sample below outlines all required API interactions, including order retrieval, passenger selection, split request submission, and confirmation of the newly created order, ensuring both the original and split orders are correctly updated and linked.

  • XML Samples

    Amend APIS Info Flow
    File
    Download
    Created
    Modified
    OrderRetrieve Request
    31-October-2025
    31-October-2025
    OrderRetrieve Response
    31-October-2025
    31-October-2025
    OrderChange Request
    31-October-2025
    31-October-2025
    OrderChange Response
    31-October-2025
    31-October-2025
     

    Inputs/Outputs

     
    OrderRetrieve
     

    Request

    • OrderID or Booking Reference
     

    Response

    • Confirmation of successful amendment
    • Error or validation messages
     
    OrderChange
     

    Request

    • Passenger detail - The specific passenger(s) whose APIS information requires amendment.
    • Updated APIS data - Passport or ID number, Document expiry date, Country of issue/nationality, Date of birth, Gender, and Country of residence
     

    Response

    • OrderID — the updated original order
    • Confirmation on updated APIS information
       
 

How to Implement Amend APIS Info

The following UpdatePax elements need to be added to the OrderChangeRQ. This provides the capability to modify previously submitted passenger's APIS information.

Click on the XML Samples tab for the full Amend APIS Info sample

<UpdatePax>
XML Snippet
Element
Details
DataType
M/O/C
<UpdatePax>
Function to update existing PAX details
M
<Current>
Refers to the existing PAX details
O
<PaxRefID>
Reference to the Passenger ID
Alphanumeric
M
<New>
Refers to the updated PAX details
O
<PaxRefID>
Reference to the Passenger ID
Alphanumeric
M
<UpdatePax>
   <Current>
      <PaxRefID>ADULT_1</PaxRefID>
   </Current> 
   <New>
      <PaxRefID>ADULT_TEMP_1</PaxRefID>
   </New>
</UpdatePax>
 
<request>
    <bookingref xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
        <bookingid>RPNSPU</bookingid>
    </bookingref>
    <changeorderchoice xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
        <updatepax>
            <current>
                <paxrefid>ADULT_1</paxrefid>
            </current>
            <new>
                <paxrefid>ADULT_TEMP_1</paxrefid>
            </new>
        </updatepax>
    </changeorderchoice>
    <datalists xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
        <paxlist>
            <pax>
                <paxid>ADULT_1</paxid>
                <ptc>ADT</ptc>
            </pax>
            <pax>
                <identitydoc>
                    <birthdate>2001-08-18</birthdate>
                    <citizenshipcountrycode>IND</citizenshipcountrycode>
                    <expirydate>2036-08-09</expirydate>
                    <gendercode>X</gendercode>
                    <givenname>DAVID</givenname>
                    <identitydocid>11223344</identitydocid>
                    <identitydoctypecode>PT</identitydoctypecode>
                    <issuedate>2024-06-03</issuedate>
                    <issuingcountrycode>IND</issuingcountrycode>
                    <residencecountrycode>IND</residencecountrycode>
                    <surname>SMITH</surname>
                    <visa>
                        <expirydate>2026-06-03</expirydate>
                        <hostcountrycode>USA</hostcountrycode>
                        <issuingcountrycode>USA</issuingcountrycode>
                        <visaid>123456</visaid>
                    </visa>
                </identitydoc>
                <identitydoc>
                    <expirydate>2026-06-03</expirydate>
                    <givenname>DAVID</givenname>
                    <identitydocid>123456789</identitydocid>
                    <identitydoctypecode>CR</identitydoctypecode>
                    <issuedate>2024-06-03</issuedate>
                    <issuingcountrycode>USA</issuingcountrycode>
                    <surname>SMITH</surname>
                </identitydoc>
                <paxid>ADULT_TEMP_1</paxid>
                <ptc>ADT</ptc>
                <redresscase>
                    <countrycode>USA</countrycode>
                    <redresscaseid>123456</redresscaseid>
                </redresscase>
            </pax>
        </paxlist>
    </datalists>
    <order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
        <orderid>VS932RPNSPU25</orderid>
        <ownercode>VS</ownercode>
    </order></request>