Usage

Summary

Update Passenger Security Information supports the following:

Adding, updating, and deleting passenger travel documentation as required by government authorities:
- Adding and deleting documents is managed by an attribute named Action within the API. The attribute can set to EDIT or DELETE, allowing you to add or delete documents respectively.
- Deleting a travel document removes all associated documents under the same group.
Adding, updating, and deleting travel documents for a single passenger:
- In the event of a passenger traveling with a lap infant, SSCI assigns the same unique ID to both. However, if the passenger is traveling with a seat infant, SSCI assigns different unique IDs to each. In this case, Update Passenger Security Information must be called separately for the passenger and the seat infant. There are some functions where adult and infant requests are triggered together; for example, Timatic Override and Stay Type for Timatic.
- A travel document can be added for the infant by using the attribute Infant. When the value of the attribute is true, the documents are added for the infant.
Adding all travel-related documents and information in a single call (travel document, visa information, address information, contact information, and information for Timatic clearance)
Adding up to two (2) travel documents for the passenger (passport and facilitation documents)
Triggering a clearance request to government authorities according to the itinerary involved
Updating existing travel document data for a passenger for whom a similar document type was added previously
Upon activating the Document Validation functionality, the API performs a format and duplicate check validation on the travel document
Document Verification (DOCV) for the passenger:
- The document verification for the passenger/infant can only succeed if all necessary travel documents are added.

The minimum information required to be sent in the request body is shown below:

Element	Mandatory	Comments
`UpdateSecurityInfoRQ/Itinerary/Airline`	Y	Airline 2 letter code
`UpdateSecurityInfoRQ/Itinerary/Flight`	Y	Flight number
`UpdateSecurityInfoRQ/Itinerary/BookingClass`	N	Booking class (`Y` , `F`)
`UpdateSecurityInfoRQ/Itinerary/DepartureDate`	Y	Flight departure date
`UpdateSecurityInfoRQ/Itinerary/Origin`	Y	Origin airport code
`UpdateSecurityInfoRQ/PassengerInfo/LastName`	Y	Last name of the passenger
`UpdateSecurityInfoRQ/PassengerInfo/FirstName`	N	First name of the passenger
`UpdateSecurityInfoRQ/PassengerInfo/PassengerID`	Y	Unique passenger identification number

Important! Refer to the Resources tab for the full WSDLs and schemas for the current and last five (5) versions of this API.

Minor versions

The following enhancement(s) are available in the minor versions of the request/response schema:

Version	Description
4.0.0	Base version.
4.0.1	Changes to support 25-digit Visa number. Support two (YY) and four-digit (YYYY) Year format in travel DOCS.
4.1.0	Adding functionality to manually override document validation.
4.1.1	Created to support Visa Regulatory and Gender `X`.
4.2.0	Created to support the expiry date for Visas. The prior versions mentioned above have also been updated to support this feature.

The above enhancement(s) require that the Version attribute be specified in the UpdateSecurityInfoRQ element of the request; otherwise, only the features in the base version (4.0.0) will be available (refer to the Specifying a Minor Version section of this guide for more information).

Travel Document (DOCS) guidelines

Passenger records may be updated by adding or deleting passenger travel documents. For a list of supported travel document types, refer to the Appendix section of this guide.
Add the passenger's last name, first name, document number, nationality, gender, and more.
Mandatory fields are dependent on the type of the document selected with no schema validation.
When documents are added successfully, the edit will be available within the free text information in the response and in the edit code list.

Travel document validations

Upon activation for an airline, this functionality ensures that a travel document validation check will be performed by SSCI for all passengers during the check-in process.

The Document Validation functionality in Update Passenger Security Information:

Validates the format of travel documents for passengers against pre-defined criteria
Determines if any duplicate travel documents exist in a flight

The SSCI system associates the travel document to the passenger only if it satisfies predefined criteria and is not a duplicate.

Document format check

When travel documents are added via the UpdateSecurityInfoRQ request, the SSCI system performs a format check for the travel documents against predefined parameters for both adult and infant passengers.

In the case of a travel document not meeting the required format check, the system will respond with the error messages below:

If document type is Passport
- 16011 - PLEASE VALIDATE PASSPORT NUMBER
If document type is anything other than Passport:
- 16016 - PLEASE VALIDATE DOCUMENT NUMBER

Document duplicate check

Update Passenger Security Information checks if any passengers on flight have duplicate travel documents before storing travel document details.

The duplicate check is performed:

On passengers connecting host flights.
For both adult and infant travel documents. Infant documents:
- Are not validated against the associated adult’s travel document.
- Can be validated against the associated adult document and treated as an independent travel document based on carrier configuration settings.

Documents may be classified as duplicates if two (2) or more passengers have travel documents with the same document type, document number, or country of issue. In the event that the SSCI system classifies the travel document as a duplicate, the system will respond with one of the following error messages:

Single duplicate passport
- When duplicate with an adult/child passenger:
  
  16012 - PASSPORT NUMBER SAME AS SMITH/JOHN ON EY111 12NOV
When duplicate with an infant passenger:

16017 – PASSPORT NUMBER SAME AS INFANT WITH SMITH/JOHN ON EY111 12NOV
Multiple duplicate passports:

16013 – NNN* GUEST HOLDING SAME PASSPORT NUMBER. CHECK DUPLICATE PASSPORT LIST FOR EY 111 12NOV
- One duplicate document (a document other than a passport):
  - When duplicate with an adult/child passenger:
  16014 – DOCUMENT* NUMBER SAME AS SMITH/JOHN ON EY111 12NOV
- When duplicate with an infant passenger:
16018 – DOCUMENT* NUMBER SAME AS INFANT WITH SMITH/JOHN ON EY111 12NOV
Multiple Duplicate Documents (documents other than a passport):

16015 – NNN* GUEST HOLDING SAME DOCUMENT* NUMBER ON EY111 12NOV

Note:

NNN* - Number of Passengers

DOCUMENT* - Document Name

If a passenger holds two travel documents, and if both the documents have a duplicate, SSCI will respond with an error message above for both of the documents.

Override document validation

In the event of there being a legitimate reason to override the travel documentation validation check, you can override it by passing the SkipValidation indicator while adding DOCS.

Address Information (DOCA) guidelines

Address information supports two types of addresses; Resident and Destination.
One resident address and one destination address can be added for a passenger.
Deleting either of the address types will delete all existing addresses.

Passenger Contact Information (PCTC) guidelines

Passenger contact information can only be added for an adult.
When only the root element is added without any data, the system considers this sample as the passenger refusing to provide contact details.
Update Passenger Security Information supports the following combinations for passenger contact information:
- Name, phone, and related data
- Name and phone
- Name and related data
- Phone and related data

Sample request for adding passenger refusal

Functions	Description
Add/delete passenger contact info	Complete `UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/PassengerContactInfo` with the required details and proper `@action` specified.
Add passenger refusal	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/PassengerContactInfo`, without any data added.

Timatic documents and verification

The use of Timatic Auto Check enables airlines and ground handlers to automate passenger travel document compliance for international travelers.

The functionalities available for Timatic include:

Adding and removing Timatic document information
Ad hoc Timatic calls
Add and remove an Override Timatic Status – this does not call the external IATA web service.

Adding and removing Timatic document information

When adding Timatic documents, one of the following details must be added:

Document type
Resident document
Stay type
Return date

Element	Attribute	Mandatory	Description
`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/TimaticDocs/`	`@action`	Y	`EDIT` or `DELETE` indicates adding or deleting Timatic details.
`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/TimaticDocs/`	`@infant`	Y	Set to `true` if adding or deleting details for an infant.
`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/TimaticDocs/TimaticDoc/DocumentType`		N	List of IATA provided document types – refer to the Appendix section for more information.
`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/TimaticDocs/TimaticDoc/ResidencyDocumentType`		N	List of IATA-provided residency document types.
`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/TimaticDocs/TimaticStay/StayType`		N	Purpose of the visit, which may be `Vacation`, `Duty` or `Business`.
`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/TimaticDocs/ReturnDate`		N	Return date for the passenger. Overrides the return date if there was already a return date in the PNR.

Ad-hoc Timatic call

When document validation (DOCV) is present, the API performs an internal call to Timatic's verification system on an ad-hoc basis.

The response from Timatic will be one of the following:

OK to Board – Passenger has all required travel documentation and all rules are satisfied.
Not OK to Board - Based on the information provided, one or more rules are not satisfied. Relevant travel requirements will be described in the detailed response.
Conditional - Not possible to determine if all rules are satisfied from the information submitted. Relevant travel requirements will be described in the detailed response.

Function	Description
Adhoc Timatic call	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ValidateSecurityInfo/RequestTimatic`

Override Timatic status

Update Passenger Security Information supports Timatic status override; check-in agents can override the Timatic status and continue with the check-in process. The override entry will be used if the check-in agent chooses to bypass the Timatic check altogether before making the DOCV or DCVI entry.

Note: If the passenger is traveling with a lap infant, the override will also apply to the infant.

Function	Description
Add/delete override	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/Timatic/OverrideTimatic` with a proper `@action`

Interactive ad hoc calls to governmental authorities

Send and receive interactive messages to governmental authorities to obtain notice of the passenger’s eligibility to enter or transit the country.

If the passenger does not have a travel document entered or has a travel document that is not accepted by government authorities, an error message will be returned.

APP (Advanced Passenger Processing)
iAPP (Interactive Advanced Passenger Processing)
DHS Clearance

Advanced Passenger Processing (APP)

APP is a means of collecting and conveying Advance Passenger Information (API) to governments and obtaining advice on the eligibility of passengers.

It supports the following functions:

Functions	Description
Send an ad hoc request	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ValidateSecurityInfo/RequestAPP`
Sending a cancel request	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/APP/CancelAPP`
Override government	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/APP/OverrideAPPList/OverrideAPP/@type` as `"G"`
Override airline	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/APP/OverrideAPPList/OverrideAPP/@type` as `"A"`

Update Passenger Security Information supports override for 5 countries at a time.
If the passenger is traveling with an infant, the APP will be automatically sent for the infant as well. There is no attribute needed to set infant as true.

Interactive Advanced Passenger Processing (iAPP)

iAPP is currently available for two countries: South Korea (KR) and Taiwan (TW).

iAPP provides customer and flight information to:

Korean Immigration Service (KIS) for security screening purposes for flights departing South Korea
National Immigration Agency of Taiwan (NIA) for security screening purposes for flights departing Taiwan

Functions	Description
Send an ad hoc request	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ValidateSecurityInfo/RequestGOV` with a proper country code (`KR` or `TW`)
Override	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/GOV/OverrideGOV` with a proper action and country code (`KR` or `TW`)
Add/cancel	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/GOV/OverrideGOV` with a proper action and country code (`KR` or `TW`)

If the passenger is traveling with an infant, iAPP will be automatically sent for the i infant as well.
The status override does not change a passenger’s original status, it only allows the check-in process to proceed.

If the original request returns an error, or a Not Cleared status, you can send an override request and then proceed with check-in under certain circumstances, such as:

The status is Not Cleared, but the Ministry of Justice (MOJ) approves the travel
The status is Selectee and your airline has chosen the option to ask for a supervisor's approval prior to checking-in or issuing bag tags for the passenger
The passenger’s passport has expired over a weekend or a holiday. Before this API can be called, the GOV edit code must be present in the passenger record with a Select status. The override entry is controlled by a specific EPR keyword (SELECT) and duty code (7, 8, or cross-of-lorraine)

Department of Homeland Security (DHS)

Update Passenger Security Information provides customer and flight information to the U.S. Department of Homeland Security (DHS) for security screening purposes. This is applicable to the following types of flights:

Domestic flights within the U.S.
Flights crossing the U.S. border.
Flight operated by a U.S. Flag Carrier outside US territory.
Flights flying over U.S. territory.

Functions	Description
Send an ad hoc request	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ValidateSecurityInfo/RequestDHS`

An override of DHS is not supported in the version (4.X.X) of Update Passenger Security Information.

Document verification

This feature allows you to add or delete travel documentation verification. This may trigger internal calls to the following systems, depending on the flight and the passenger’s itinerary:

APP
DHS
Timatic
iAPP (Korea and Taiwan)

If the verification is cleared, the request will be successful. Document verification/cancellation must be done separately for the passenger and the infant.

Functions	Description
Adding	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ValidateSecurityInfo/RequestDOCV`
Cancelling	`UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo/DOCV`, with the `@action` as `Delete`

If the passenger record does not have an accepted travel document added, an error message will be returned.

Override visa requirements

If there is a legitimate reason to override the Visa entry requirement, override the requirement by passing the GPV override code during check-in.

Response Format

Xpath	Comments
`UpdateSecurityInfoRS/ItineraryResponseList/STL:ItineraryInfoResponse`	Itinerary data available in the request will be populated back in the response.
`UpdateSecurityInfoRS/PassengerInfoResponseList/STL:PassengerInfoResponse`	Passenger data available in the request will be populated back in the response.
`UpdateSecurityInfoRS/Result/STL:Status` - Success	Request was successful, with passenger data successfully updated.
`UpdateSecurityInfoRS/Result/STL:Status` - Partial Success	At least one of the functional requests was successful while at least one failed. Passenger data is partially updated.
`UpdateSecurityInfoRS/Result/STL:Status` - Business Logic Error	All functional requests failed. Passenger data is not updated.
`UpdateSecurityInfoRS/Result/STL:Status` - Application Error	Unexpected error - passenger data is not updated.
`UpdateSecurityInfoRS/Result/STL:CompletionStatus`	`Complete` if the SOAP request was successful in calling the SSCI Host. `Incomplete` if SSCI Host throws an error or did not connect to SSCI Host.
`UpdateSecurityInfoRS/Result/STL:System`	CKI-WS
`UpdateSecurityInfoRS/Result/STL:SystemSpecificResults/`	Repeated if more than one error is returned.
`UpdateSecurityInfoRS/Result/STL:SystemSpecificResults/STL:ErrorMessage`	Error description. Usually the same text returned from the Host or error text returned from the the SSCI Open System.
`UpdateSecurityInfoRS/Result/STL:SystemSpecificResults/STL:ErrorMessage/@code`	The error code, either from the Host or Open System.
`UpdateSecurityInfoRS/Result/STL:SystemSpecificResults/STL:ShortText`	Error description. Usually the same text returned from the Host or error text returned from the SSCI Open System.
`UpdateSecurityInfoRS/Result/STL:SystemSpecificResults/STL:Element`	The name of the XML element that caused the error.

Multiple updates in a single request

Multiple updates are supported in Update Passenger Security Information for the following two (2) options, but each option must be called one at a time:

UpdateSecurityInfoRQ/PassengerSecurityInfo/ManageSecurityInfo
UpdateSecurityInfoRQ/PassengerSecurityInfo/ValidateSecurityInfo

Note: The response and status will vary if multiple requests are made.

Case	Comments
If all the requests are successful	`UpdateSecurityInfoRS/Result/STL:Status = "Success"` `UpdateSecurityInfoRS/Result/STL:CompletionStatus = “Complete”` `UpdateSecurityInfoRS/Result/STL:SystemSpecificResults` will not be populated.
If one of the requests fails	`UpdateSecurityInfoRS/Result/STL:Status = "Partial Success"` `UpdateSecurityInfoRS/Result/STL:SystemSpecificResults` will be populated with all relevant details.
If all the requests fail	`UpdateSecurityInfoRS/Result/STL:Status = "Business logic Error"` `UpdateSecurityInfoRS/Result/STL:SystemSpecificResults` will be populated with all relevant details.

Sample success response:

Successfully added edit codes will be available under:

UpdateSecurityInfoRS/PassengerInfoResponseList/PassengerInfoResponse/EditCodeList

Image of an example success response

Sample multiple error response:

Image of an example multiple error response

Partial success response: