Advance Passenger Information System (APIS)

GDS Entry Summary and New SSR Codes

from Edward Hasbrouck's blog, The Practical Nomad, 4 October 2005

IATA Standard SSR codes for Advance Passenger Information

DOCS - Passenger Primary Travel Document Information

DOCO - Passenger Other Travel Related Information

DOCA - Passenger Address Information

GDS Entry Formats for API Data

SABRE

AMADEUS

GALILEO / APOLLO

WORLDSPAN

GDS ENTRIES SUMMARY

GDS

SSR DOCS/DOCO/DOCS ENTRIES

Agency Reference :

SABRE

DOCS

3DOCS(seg nbr)/(doc type)/(issue country)/(doc nbr)/(nationality country)/(date of birth)/(gender)/(doc expire ate)/(last name)/ (first name)/(middle initial)/(Multi passenger passport indicator)-(passenger number)

DOCO

3DOCO(seg nbr)/(place of birth)/(doc type)/(doc nbr)/(issue country)/(issue date)/(applicable country)/(infant indicator)-(passenger number)

DOCA

3DOCA(seg nbr)/(address type) /(country)/(street)/(city)/(state)/ (zip)/(infant indicator)-(passenger number)

Y/AAI/PDT/P60

http://eServices.Sabre.com

Effective –

5 October 2005

AMADEUS

Effective –

19 October 2005

DOCS

SR DOCS YY HK1-(Document type)-(Document Issuing Country/State)-(Document Number)-(Nationality)-(Date of Birth)-(Gender)-(Document Expiry date)-(Surname)-(First Given Name)-(Second Name)-(Multi-Passenger Passport Holder)/(Segment Number)/(Passenger Number)

DOCO

SR DOCO YY HK1-(Place of Birth)-(Document Type)-(Visa Document Number)-(Place of Issue)-(Document issue date)-(Visa Applicable country)-(Infant Indicator)/(Segment Number)/(Passenger Number)

DOCA

SR DOCA YY HK1-(Type of address)-(Country)-(Address Details)-(City)-(State/Province/Country)-(Zip code/Postal code)-(Infant Indicator)/(Segment Number)/(Passenger Number)

GPAPI or HE SSR

GALILEO

Effective –

4 October 2005

DOCS

SI.P1S1/DOCS*(Document Type)/(Issuing Country Code)/(Document Number)/(Nationality)/(Date of Birth)/(Gender)/(Document Expiry date)/(Surname)/(First Given Name)/(Second Given Name)/(multi-passenger passport holder)

DOCO

SI.P1S1/DOCO*(Place of Birth)/(Document Type)/(Visa Document Number)/(Visa Place of Issue)/(Visa Issue Date)/(Visa Applicable Country)/(Infant Indicator)

DOCA

SI.P1S1/DOCA*(Type of Address)/(Country)/(Address Details)/(City)/ (Status/Province/County)/(Zip Code/Postal Code)/(Infant Indicator)

GC*200/53

APOLLO

Effective –

4 October 05

DOCS

@:3DOCSS1/N1/(Document Type)/(Issuing Country Code)/(Document Number)/(Nationality)/(Date of Birth)/(Gender)/(Document Expiry date)/(Surname)/(First Given Name)/(Second Given Name)/(multi-passenger passport holder)

DOCO

@:3DOCOS1/N1/(Place of Birth)/(Document Type)/(Visa Document Number)/(Visa Place of Issue)/(Visa Issue Date)/(Visa Applicable Country)/(Infant Indicator)

DOCA

@:3DOCAS1/N1/(Type of Address)/(Country)/(Address Details)/(City)/ (State/Province/County)/(Zip Code/Postal Code)/(Infant Indicator)

( for US ) - HELP ENHANCE-APIS

( for CA ) - S*GEM/APIS S*AME/APIS

WORLDSPAN

Effective –

4 October 2005

DOCS

3SSR DOCS YY HK1/(Document Type)/(Issuing Country Code)/ (Document Number)/(Nationality)/(Date of Birth)/(Gender)/(Document Expiry date)/(Surname)/(First Given Name)/(Second Given Name)/(multi-passenger passport holder)-(Passenger Number)

DOCO

3SSR DOCO YY HK1/(Place of Birth)/(Document Type)/(Visa Document Number)/(Visa Place of Issue)/(Visa Issue Date)/(Visa Applicable Country)/(Infant Indicator)-(Passenger Number)

DOCA

3SSR DOCA YY HK1/(Type of Address)/(Country)/(Address Details)/(City)/ (State/Province/County)/(Zip Code/Postal Code)/(Infant Indicator)-(Passenger Number)

HELP APIS

IATA Standard SSR codes for Advance Passenger Information

SSR Code	Information Type	Component	Number and Type of Characters	Notes
DOCS	Passenger Primary Travel Document Information	Travel Document Type √ *Mandatory*	1-2a	Valid Document Type : AC - Crew Member Certificate P - Passenger Passport IP - Passport Care F - Approved non-standard identify documents used for travel (as defined by the issuing Country/ State) A - Identify Card C - Identify Card I - Identify Card
		Travel Document Issuing Country/State √ *Mandatory*	1-3a
		Travel Document Number √ *Mandatory*	Max 15an
		Passenger Nationality √ *Mandatory*	1-3a
		Date of Birth √ *Mandatory*	7an
		Gender of Passenger √ *Mandatory*	1-2a	F - Female M - Male FI - Female infant MI - Male infant U - Undisclosed Gender
		Travel Document Expiry Date √ *Mandatory*	7an
		Travel Document Surname √ *Mandatory*	Max 30a
		Travel Document First Given Name √ *Mandatory if present on travel document*	Max 30a
		Travel Document Second Given Name	Max 30a
		If multi-passenger passport and this SSR is for the primary passport holder, include the letter (H)	1a
		Passenger Number √ *Mandatory*

SSR Code	Information Type	Component	Number and Type of Characters	Notes
DOCO	Passenger Other Travel Related Information	Passenger Place of Birth	Max 35a
		Travel Document Type √ *Mandatory if Visa is present*	1a	V - Visa
		Visa Document Number √ *Mandatory for Visa only*	Max 15an
		Visa Document Place of Issue √ *Mandatory for Visa only*	Max 35a
		Visa Document Issue Date √ *Mandatory for Visa only*	7an
		Country/State for which the Visa is applicable √ *Mandatory for Visa only*	1-3a
		Infant Indicator √ *Mandatory if an infant not occupying seat*	1a	I - Infant
		Passenger Number √ *Mandatory*

SSR Code	Information Type	Component	Number and Type of Characters	Notes
DOCA	Passenger Address Information	Type of Address √ *Mandatory*	1a	D - Destination R - Residence
		Country √ *Mandatory*	1-3a
		Address Details	Max 35an
		City √ *Mandatory*	Max 35a
		State/Province/Country	Max 35a
		Zip Code/Postal Code	17an
		Infant Indicator √ *Mandatory if an infant not occupying seat*	1a
		Passenger Number

GDS Entry for New SSR Codes

SABRE < Agent reference : Y/AAI/PDT/P60 >

< Agent reference : http://eServices.Sabre.com >

(Effective - 5 October 2005)

1B/

1F/ AA

DOCS

Format :

Mandatory elements:

Document Type
Document country of issue
Document Number
Document Nationality Country
Date of Birth
Gender/Infant gender
Doc expiration date
Last Name
First Name
Passenger number

Example:

3DOCS1/P/US/506435405/USA/06FEB52/F/11FEB08/PEREZ/MARIA/N/H-1.1

Mandatory Components only:

3DOCS/P/US/323456/USA/06FEB52/F/11FEB08/PEREZ/MARIA-1.1

Multi-passenger Passport without Second Given name:

3DOCS/P/US/323456/USA/06FEB52/F/11FEB08/PEREZ/MARIA//H-1.1

DOCO

Format :

3DOCO(seg nbr)/(place of birth)/(doc type)/(doc nbr)/(issue country)/(issue date)/(applicable country)/(infant indicator)-(passenger number)

Mandatory elements:

Place of Birth (if doc type omitted)
Document Type ( if place of birth omitted)
Document Number
Place of Issue
Visa issue date
Applicable country
Passenger number

Example:

3DOCO1/LONLON/V/789789/UK/14JUN04/USA-1.2

Mandatory Components only:

3DOCO//V/789789/HOUSTON/14JUN04/USA-1.2

(Document type included, but place of birth not)

3DOCO/MUNICH-1.1

(Place of birth included, but document type not)

Name Select:

3DOCO/MUNICH/V/789789/HOUSTON/14JUN04/USA-1.1

3DOCO/MUNICH/V/789789/HOUSTON/14JUN04/USA-1.1-5.1

Multi Segment select:

3DOCO1,3-5/MUNICH/V/789789/HOUSTON/14JUN04/USA

Infant example:

3DOCO/MUNICH/V/789789/HOUSTON/14JUN04/USA/I-1.1

DOCA

Format :

3DOCA(seg nbr)/(address type) /(country)/(street)/(city)/(state)/ (zip)/(infant indicator)-(passenger number)

Mandatory elements:

Address type (R – Residence, D – Destination)
Country code
Street (if address type ‘D’)
City (if address type ‘D’)

Example:

3DOCA2/D/US/123 CITY STREET/NYC/NY/76100-1.2

Mandatory Components only:

3DOCA/D/US/987 MAIN/EULESS

(destination address type)

3DOCA/R/GB

(residence address type)

Omit State information :

3DOCA/D/US/123 GOLDEN STREET/SEA//22000-1.2

Infant example:

3DOCA/D/US/123 CITY STREET/NYC/NY/76100/I-1.2

Where a field has been omitted, a slash (/) must be added to the entry to denote that the field is not present unless the missing items are at the end or the beginning of the entry.

AMADEUS < Agency reference : GPAPI or HE SSR >

(Effective - 19 October 2005)

1A	DOCS	Format :	SR DOCS YY HK1-(Document type)-(Document Issuing Country/State)-(Document Number)-(Nationality)-(Date of Birth)-(Gender)-(Document Expiry date)-(Surname)-(First Given Name)-(Second Name)-(Multi-Passenger Passport Holder)/(Segment Number)/(Passenger Number)	Mandatory elements: Travel Document Type Travel Document Issuing Country/State Travel Document Number Passenger Nationality Date of Birth Gender Travel Document Expiry Date Surname First Given Name Passenger Number
		Example :	SR DOCS YY HK1-P-GBR-01234567-GBR-30JUN74-M-14APR09-JOHNSON-SIMON-A-H/S4/P1 Mandatory Components only: SR DOCS YY HK1-P-GBR-01234567-GBR-30JUN74-M-14APR09-JOHNSON-SIMON/P1 Multi-passenger Passport without Second Given name : SR DOCS YY HK1-P-GBR-01234567-GBR-30JUN74-M-14APR09-JOHNSON-SIMON--H/P1
	DOCO	Format :	SR DOCO YY HK1-(Place of Birth)-(Document Type)-(Visa Document Number)-(Place of Issue)-(Document issue date)-(Visa Applicable country)-(Infant Indicator)/(Segment Number)/(Passenger Number)	Mandatory elements: Document Type ( if Visa data is present) Document Number Place of Issue Visa issue date Applicable country Passenger number
		Example :	SR DOCO YY HK1-BASILDON GBR-V-11223344-LONDON-10JAN01-USA/S4/P1 Mandatory Components only: SR DOCO YY HK1--V-9875612-LONDON-16JAN05-GBR/P1 Omit Document Type : SR DOCO YY HK1-LONDON/P1 Infant example: SR DOCO YY HK1-USA-V-9875612-LONDON-16JAN05-GBR-I/P1
	DOCA	Format :	SR DOCA YY HK1-(Type of address)-(Country)-(Address Details)-(City)-(State/Province/Country)-(Zip code/Postal code)-(Infant Indicator)/(Segment Number)/(Passenger Number)	Mandatory elements: Address type (R – Residence, D – Destination) Country code Street (if address type ‘D’) City (if address type ‘D’)
		Example :	SR DOCA YY HK1-D-US-301 PARK AVENUE-NEW YORK-NY-10022/S4/P1 Mandatory Components only: SR DOCA YY HK1-D-US-301 PARK AVENUE-NEW YORK/P1 Omit State information : SR DOCA YY HK1-D-US-301 PARK AVENUE-NEW YORK--10022/P1 Infant example: SR DOCA YY HK1-D-GB-209 KINGS STREET-LONDON-I/P1

Where a field has been omitted, a dash (-) must be added to the entry to denote that the field is not present unless the missing items are at the end or the beginning of the entry.

GALILEO < Agency reference : GC*200/53 >

(Effective - 4 October 2005)

1G	DOCS	Format :	SI.P1S1/DOCS*(Document Type)/(Issuing Country Code)/(Document Number)/(Nationality)/(Date of Birth)/(Gender)/(Document Expiry date)/(Surname)/(First Given Name)/(Second Given Name)/(multi-passenger passport holder)	Mandatory elements: Passenger Number Segment Number (1^st YY segment) Document Type Document country of issue Document Number Document Nationality Country Date of Birth Gender/Infant gender Document expiry date Surname Name First Given Name
		Example :	SI.P1S1/DOCSP/SIN/S123456/SIN/12JUL66/M/23OCT05/SMITH/JOHN/RICHARD/H* Mandatory Components only: SI.P1S1/DOCSP/SIN/S123456/SIN/12JUL66/M/23OCT05/SMITH/JOHN* Multi-passenger Passport without Second Given name: SI.P1S1/DOCSP/SIN/S123456/SIN/12JUL66/M/23OCT05/SMITH/JOHN//H*
	DOCO	Format :	SI.P1S1/DOCO*(Place of Birth)/(Document Type)/(Visa Document Number)/(Visa Place of Issue)/(Visa Issue Date)/(Visa Applicable Country)/(Infant Indicator)	Mandatory elements: Passenger Number Segment Number (1^st YY segment) Document Type (Visa) Document Number Place of Issue Visa issue date Applicable country
		Example :	SI.P1S1/DOCOPARIS FR/V/12345123/LONDON GBR/14MAR03/USA* Mandatory Components only: SI.P1S1/DOCOV/12345123/LONDON GBR/14MAR03/USA* (Visa information included) SI.P1S1/DOCOPARIS FR* (Place of Birth included) Infant example : SI.P1S1/DOCOV/12345123/LONDON GBR/14MAR03/USA/I* SI.P1S1/DOCOPARIS FR/I*
	DOCA	Format :	SI.P1S1/DOCA*(Type of Address)/(Country)/(Address Details)/(City)/ (Status/Province/County)/(Zip Code/Postal Code)/(Infant Indicator)	Mandatory elements: Passenger Number Segment Number (1^st YY segment) Type of Address Country City
		Example :	SI.P1S1/DOCAR/USA/1800 SMITH STREET/HOUSTON/TX/12345* Mandatory Components only: SI.P1S1/DOCAR/USA/1800 SMITH STREET/HOUSTON/TX/12345* Infant example : SI.P1S1/DOCAR/USA/1800 SMITH STREET/HOUSTON/TX/12345/I*

Where a field has been omitted, a slash (/) must be added to the entry to denote that the field is not present unless the missing items are at the end or the beginning of the entry.
Default SSR applied to all segments if no segment relation selected.

APOLLO < Agency Reference : ( for US ) - HELP ENHANCE-APIS >

< ( for CA ) - S*GEM/APIS S*AME/APIS >

(Effective - 4 October 05)

1V	DOCS	Format :	@:3DOCSS1/N1/(Document Type)/(Issuing Country Code)/(Document Number)/(Nationality)/(Date of Birth)/(Gender)/(Document Expiry date)/(Surname)/(First Given Name)/(Second Given Name)/(multi-passenger passport holder)	Mandatory elements: Segment Number (1^st YY segment) Passenger Number Document Type Issuing country Document Number Document Nationality Date of Birth Gender/Infant gender Doc expiration date Last Name First Name
		Example :	@:3DOCSS1/N1/P/SIN/S123456/SIN/12JUL66/M/23OCT05/SMITH/JOHN/RICHARD/H Mandatory Components only: @:3DOCSS1/N1/P/SIN/S123456/SIN/12JUL66/M/23OCT05/SMITH/JOHN Multi-passenger Passport without Second Given name: @:3DOCSS1/N1/P/SIN/S123456/SIN/12JUL66/M/23OCT05/SMITH/JOHN//H
	DOCO	Format :	@:3DOCOS1/N1/(Place of Birth)/(Document Type)/(Visa Document Number)/(Visa Place of Issue)/(Visa Issue Date)/(Visa Applicable Country)/(Infant Indicator)	Mandatory elements: Segment Number (1^st YY segment) Passenger Number Document Type (Visa) Document Number Place of Issue Visa issue date Applicable country
		Example :	@:3DOCOS1/N1/PARIS FR/V/12345123/LONDON GBR/14MAR03/USA Mandatory Components only: @:3DOCOS1/N1/V/12345123/LONDON GBR/14MAR03/USA (Visa information included) @:3DOCOS1/N1/PARIS FR (Place of Birth included) Infant example: @:3DOCOS1/N1/V/12345123/LONDON GBR/14MAR03/USA/I
	DOCA	Format :	@:3DOCAS1/N1/(Type of Address)/(Country)/(Address Details)/(City)/ (State/Province/County)/(Zip Code/Postal Code)/(Infant Indicator)	Mandatory elements: Segment Number (1^st YY segment) Passenger Number Type of Address Country City
		Example :	@:3DOCAS1/N1/R/USA/1800 SMITH STREET/HOUSTON/TX/12345 Mandatory Components only: @:3DOCAS1/N1/R/USA/1800 SMITH STREET/HOUSTON Omit address details and State: @:3DOCAS1/N1/R/USA//HOUSTON//12345 Infant example: @:3DOCAS1/N1/R/USA/1800 SMITH STREET/HOUSTON/TX/12345/I

Where a field has been omitted, a slash (/) must be added to the entry to denote that the field is not present unless the missing items are at the end or the beginning of the entry.
Default SSR applied to all segments if no segment relation selected.

WOLRDSPAN < Agency Reference : HELP APIS >

(Effective - 4 October 2005)

1P	DOCS	Format :	3SSR DOCS YY HK1/(Document Type)/(Issuing Country Code)/ (Document Number)/(Nationality)/(Date of Birth)/(Gender)/(Document Expiry date)/(Surname)/(First Given Name)/(Second Given Name)/(multi-passenger passport holder)-(Passenger Number)	Mandatory elements: Document Type Document country of issue Document Number Document Nationality Date of Birth Gender/Infant gender Doc expiration date Surname First Given Name Passenger Number
		Example :	3SSR DOCS YY HK1/P/USA/998764/USA/12JUL66/M/23AUG06/LEE/JOHNNY/SAM/H-1.1 Mandatory Components only: 3SSR DOCS YY HK1/P/USA/998764/USA/12JUL66/M/23AUG06/LEE/JOHNNY-1.1 Multi-passenger Passport without Second Given name: 3SSR DOCS YY HK1/P/USA/998764/USA/12JUL66/M/23AUG06/LEE/JOHNNY//H-1.1
	DOCO	Format :	3SSR DOCO YY HK1/(Place of Birth)/(Document Type)/(Visa Document Number)/(Visa Place of Issue)/(Visa Issue Date)/(Visa Applicable Country)/(Infant Indicator)-(Passenger Number)	Mandatory elements: Document Type (Visa) Document Number Place of Issue Visa issue date Applicable country Passenger Number
		Example :	3SSR DOCO YY HK1/NAIROBI KENYA/V/9891404/LONDON GB/12JUL64/US-1.2 Mandatory Components only: 3SSR DOCO YY HK1//V/9891404/LONDON GB/12JUL64/US-1.2 Infant example : 3SSR DOCO YY HK1//V/9891404/LONDON GB/12JUL64/US/I-1.1
	DOCA	Format :	3SSR DOCA YY HK1/(Type of Address)/(Country)/(Address Details)/(City)/ (State/Province/County)/(Zip Code/Postal Code)/(Infant Indicator)-(Passenger Number)	Mandatory elements: Type of Address Country City Passenger Number
		Example :	3SSR DOCA YY HK1/D/US/321 VAN PLACE/HOUSTON/TX/77000-3.2 Mandatory Components only: 3SSR DOCA YY HK1/D/US//HOUSTON-1.1 Omit Address details information : 3SSR DOCA YY HK1/D/US//HOUSTON/TX/77000-1.1 Infant example : 3SSR DOCA YY HK1/D/US/321 VAN PLACE/HOUSTON/TX/77000/I-3.2

Where a field has been omitted, a slash (/) must be added to the entry to denote that the field is not present unless the missing items are at the end or the beginning of the entry.

Advance Passenger Information System (APIS)

GDS Entry Summary and New SSR Codes

from Edward Hasbrouck's blog, The Practical Nomad, 4 October 2005

IATA Standard SSR codes for Advance Passenger Information

GDS Entry Formats for API Data

GDS ENTRIES SUMMARY

IATA Standard SSR codes for Advance Passenger Information

SSR Code

Information Type

Component

Number and Type of Characters

Notes

DOCS

Travel Document Type

1-2a

Valid Document Type :

Travel Document Issuing Country/State

1-3a

Travel Document Number

Max 15an

Passenger Nationality

1-3a

Date of Birth

7an

Gender of Passenger

1-2a

F - Female

Travel Document Expiry Date

7an

Travel Document Surname

Max 30a

Travel Document First Given Name

Max 30a

Travel Document Second Given Name

Max 30a

If multi-passenger passport and this SSR is for the primary passport holder, include the letter (H)

1a

Passenger Number

SSR Code

Information Type

Component

Number and Type of Characters

Notes

DOCO

Passenger Place of Birth

Max 35a

Travel Document Type

1a

V - Visa

Visa Document Number

Max 15an

Visa Document Place of Issue

Max 35a

Visa Document Issue Date

7an

Country/State for which the Visa is applicable

1-3a

Infant Indicator

1a

I - Infant

Passenger Number

SSR Code

Information Type

Component

Number and Type of Characters

Notes

DOCA

Type of Address

1a

1-3a

Max 35an

Max 35a

Max 35a

17an

1a

GDS Entry for New SSR Codes

SABRE < Agent reference : Y/AAI/PDT/P60 >

< Agent reference : http://eServices.Sabre.com >

(Effective - 5 October 2005)

3DOCS/P/US/323456/USA/06FEB52/F/11FEB08/PEREZ/MARIA-1.1