Managing Passenger's Documents
When some reservation has been already retrieved using the POST /dcci/passenger/details service, then the POST /dcci/passenger/update service can be used to add different types of the data for the Passengers. It is possible to add:
- Documents
- Addresses
Documents
Each Passenger needs to use documents confirming their identity.
Digital Connect Check-In supports the following types of the Passenger documents:
- Passport
- Diplomatic Passport
- Service Passport
- Special Passport
- Resident Alien Card
- Permanent Resident Card
- Facilitation Document
- Military ID
- U.S. Certificate of Naturalization
- Reentry Permit
- Border crossing card
- Refugee Travel Document
- Visa Card
- National ID
- Nexus Card
Since the reservation and the Passenger's data are cached using the POST /dcci/passenger/details service, a request message to the POST /dcci/passenger/update service contains mostly document details and the identifier needed to determine which Passenger adds the document.
Example
{ "passengerDetails": [ { "passengerId": "p01.01", "documents": [ { "document": { "id": "p01.01.d01", "type": "PASSPORT", "number": "AL12345678", "personName": { "first": "John", "last": "Doe" }, "nationality": "US", "countryOfBirth": "US", "placeOfBirth": "Southlake", "dateOfBirth": "1990-01-26", "issuingCountry": "US", "expiryDate": "2015-01-26", "gender": "MALE" }, "inputMethod": "SCAN", "multinameHolder": true, "holderType": "PRIMARY" } ] } ] }
It is possible to add two or more documents and addresses in the same request. Digital Connect Check-In adds each of them separately so each requested document/address has its own operation status. If adding one of the documents failed (for example because document's validation failed), it does not impact the other data which is added in the same request.
Document's Validation
The /dcci/passenger/update service supports the functionality of validating documents provided by a Passenger. Actual validation is done by the core systems however Digital Connect Check-In can return the information about the result of the validation.
There might be two (2) issues with the Passenger's document:
- It is a duplicate of the already existing document in the reservation.
- Format of the document's number is incorrect.
Both problems are returned in the /dcci/passenger/update response as the eligibility.
Short Advance Passenger Information System (APIS)
One of the documents used by a Passenger is Facilitation Document. Depending on the route, different document details are required to be included in the Passenger's data:
APIS Type |
Issuing |
Document |
Nationality |
Date of birth |
Gender |
Expiration |
Last |
First |
---|---|---|---|---|---|---|---|---|
Short APIS |
o |
m |
o |
o |
o |
o |
m |
m |
Medium APIS |
o |
m |
m |
o |
o |
o |
m |
m |
Long APIS |
m |
m |
m |
m |
m |
m |
m |
m |
The legend:
m - mandatory
o - optional
Eligibility
When a Passenger is missing one of the mandatory documents, the /dcci/passenger/details service returns eligibility with the following details:
{ "eligibility": [ { "reason": [ { "property": [ { "name": "SUB_TYPE", "value": "API_MEDIUM" }, { "name": "DOCUMENT_NUMBER", "value": "MANDATORY" }, { "name": "LAST_NAME", "value": "MANDATORY" }, { "name": "FIRST_NAME", "value": "MANDATORY" }, { "name": "NATIONALITY", "value": "MANDATORY" } ], "category": "PASSENGER_DOES_NOT_HAVE_REQUIRED_IDENTITY_DOCUMENTS", "details": "PASSPORT__OR__ALIEN_RESIDENT_CARD__OR__PERMANENT_RESIDENT_CARD__OR__FACILITATION_DOC__OR__ MILITARY_ID__OR__US_NATURALIZATION_CERT__OR__REENTRY_PERMIT__OR__BORDER_CROSSING_CARD__OR__ REFUGEE_TRAVEL_DOCUMENT", "message": "Passenger is missing required document" } ], "type": "CHECK_IN", "notEligible": true } ] }
Addresses
Passenger's address types supported by Digital Connect Check-In are the following:
- HOME
- RESIDENCE
- WORK
- INVOICE
- OTHER
- DESTINATION
- PRIVATE
- BUSINESS
To add Passenger's address, the POST /dcci/passenger/update service can be used:
{ "passengerDetails": [ { "passengerId": "p01.01", "addresses": [ { "id": "p01.01.a01", "type": "RESIDENCE", "street1": "Sabre Drive 21", "postalCode": "123456", "country": "US", "city": "Dallas", "stateProvince": "Texas" } ] } ] }