IdentityDoc
A document which may be used to identify a person or verify aspects of a person's personal identity. If issued in a small, standard credit card size form, it is usually called an identity card. Some countries issue formal identity documents, while others may require identity verification using informal documents. When the identity document incorporates a person's photograph, it may be called photo ID. In the absence of a formal identity document, a driver's license may be accepted in many countries for identity verification. Most countries accept passports as a form of identification.
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
birthdate |
Holder's date of birth as written on the document. |
string |
false |
|
|
${prop.ignore} |
birthplaceText |
Holder's birth location (e.g. city and/or country) as written on the document. |
string |
false |
|
|
${prop.ignore} |
countryOfCitizenship |
A nation with its own government, occupying a particular territory. |
Country |
false |
|
|
${prop.ignore} |
countryOfNatl |
A nation with its own government, occupying a particular territory. |
Country |
false |
|
|
${prop.ignore} |
countryOfResidence |
A nation with its own government, occupying a particular territory. |
Country |
false |
|
|
${prop.ignore} |
expiryDate |
The date the identity document expires. |
string |
false |
|
|
${prop.ignore} |
genderCode |
Holder's gender as specified on the document (M, F, or X for unspecified). |
GenderCode |
false |
|
|
${prop.ignore} |
givenName |
Holder's first or given name, as written on the document. E.g. JOHN. |
string |
false |
|
|
${prop.ignore} |
identityDocIdentifier |
Uniquely identifies the document from all other identity documents issued by the state or organization. e.g. passport number, drivers license number. |
string |
false |
|
|
${prop.ignore} |
individual |
A single human being as distinct from a group, class, or family. |
array |
false |
Individual |
--- |
${prop.ignore} |
issueDate |
The date the identity document was issued. |
string |
false |
|
|
${prop.ignore} |
issuerCountry |
A nation with its own government, occupying a particular territory. |
Country |
false |
|
|
${prop.ignore} |
middleName |
Holder's middle name or initial, as written on the document. E.g. G, GEORGE. |
string |
false |
|
|
${prop.ignore} |
pax |
A person except members of the crew carried or to be carried with the consent of the carrier, on board of any transport vehicle such as aircraft, train, bus, ship. Holds the attributes specific to a one booking, from shopping to fulfillment. |
Pax |
false |
|
|
${prop.ignore} |
suffixName |
Holder's name suffixes and letters, as written on the document. E.g. Jr., Sr., III, Ret., Esq. |
string |
false |
|
|
${prop.ignore} |
surname |
Holder's family name or last name, as written on the document. E.g. SMITH. Excludes any potential suffix. |
string |
false |
|
|
${prop.ignore} |
titleName |
Holder's title as written on the document. E.g. Mr., Mrs., Miss, Dr. |
string |
false |
|
|
${prop.ignore} |
typeCode |
The type of passenger document. Examples: PT (Passport) |
IdentityDocTypeCode |
false |
|
|
${prop.ignore} |
visa |
An official entry in a Passport or other Travel Document made by an official of a government to indicate that the bearer has been granted authority to enter or re-enter the country or region concerned. |
array |
false |
Visa |
--- |
${prop.ignore} |
{
"birthdate" : "string",
"birthplaceText" : "string",
"countryOfCitizenship" : {
"affinityArrivalRequest" : [ { } ],
"affinityDepRequest" : [ { } ],
"bag" : { },
"carrierAgent" : [ { } ],
"citizenshipCountry" : [ { } ],
"citizenshipIdentifyingDoc" : [ { } ],
"countryCode" : { },
"countryName" : "string",
"countrySubDivision" : [ { } ],
"issuedIdentifyingDoc" : [ { } ],
"merchantAccount" : { },
"natlIdentifyingDoc" : [ { } ],
"pos" : [ { } ],
"redressCase" : [ { } ],
"residenceIdentifyingDoc" : [ { } ],
"residentialCountry" : [ { } ],
"salesTaxRegistration" : { },
"tax" : [ { } ],
"travelAgent" : [ { } ],
"visa" : [ { } ]
},
"countryOfNatl" : {
"affinityArrivalRequest" : [ { } ],
"affinityDepRequest" : [ { } ],
"bag" : { },
"carrierAgent" : [ { } ],
"citizenshipCountry" : [ { } ],
"citizenshipIdentifyingDoc" : [ { } ],
"countryCode" : { },
"countryName" : "string",
"countrySubDivision" : [ { } ],
"issuedIdentifyingDoc" : [ { } ],
"merchantAccount" : { },
"natlIdentifyingDoc" : [ { } ],
"pos" : [ { } ],
"redressCase" : [ { } ],
"residenceIdentifyingDoc" : [ { } ],
"residentialCountry" : [ { } ],
"salesTaxRegistration" : { },
"tax" : [ { } ],
"travelAgent" : [ { } ],
"visa" : [ { } ]
},
"countryOfResidence" : {
"affinityArrivalRequest" : [ { } ],
"affinityDepRequest" : [ { } ],
"bag" : { },
"carrierAgent" : [ { } ],
"citizenshipCountry" : [ { } ],
"citizenshipIdentifyingDoc" : [ { } ],
"countryCode" : { },
"countryName" : "string",
"countrySubDivision" : [ { } ],
"issuedIdentifyingDoc" : [ { } ],
"merchantAccount" : { },
"natlIdentifyingDoc" : [ { } ],
"pos" : [ { } ],
"redressCase" : [ { } ],
"residenceIdentifyingDoc" : [ { } ],
"residentialCountry" : [ { } ],
"salesTaxRegistration" : { },
"tax" : [ { } ],
"travelAgent" : [ { } ],
"visa" : [ { } ]
},
"expiryDate" : "string",
"genderCode" : {
"genderCodeEnum" : { }
},
"givenName" : "string",
"identityDocIdentifier" : "string",
"individual" : [ {
"addlName" : [ { } ],
"agent" : [ { } ],
"birthdate" : "string",
"birthplaceSimpleText" : "string",
"birthplaceText" : "string",
"contactInfo" : [ { } ],
"crewMember" : [ { } ],
"employee" : [ { } ],
"genderCode" : { },
"givenName" : "string",
"handlingAgency" : [ { } ],
"identityDoc" : [ { } ],
"individualIdentifier" : "string",
"middleName" : "string",
"nameTypeCode" : { },
"pax" : [ { } ],
"payer" : { },
"suffixName" : "string",
"surname" : "string",
"titleName" : "string"
} ],
"issueDate" : "string",
"issuerCountry" : {
"affinityArrivalRequest" : [ { } ],
"affinityDepRequest" : [ { } ],
"bag" : { },
"carrierAgent" : [ { } ],
"citizenshipCountry" : [ { } ],
"citizenshipIdentifyingDoc" : [ { } ],
"countryCode" : { },
"countryName" : "string",
"countrySubDivision" : [ { } ],
"issuedIdentifyingDoc" : [ { } ],
"merchantAccount" : { },
"natlIdentifyingDoc" : [ { } ],
"pos" : [ { } ],
"redressCase" : [ { } ],
"residenceIdentifyingDoc" : [ { } ],
"residentialCountry" : [ { } ],
"salesTaxRegistration" : { },
"tax" : [ { } ],
"travelAgent" : [ { } ],
"visa" : [ { } ]
},
"middleName" : "string",
"pax" : {
"ageMeasure" : { },
"ageOrdinal" : "integer",
"alacarteofferitem" : [ { } ],
"bag" : [ { } ],
"birthdate" : "string",
"booking" : { },
"contactInfo" : [ { } ],
"countryOfCitizenship" : { },
"countryOfResidence" : { },
"customerValueNumber" : "number",
"existingOrderCriteria" : { },
"fareDetail" : { },
"foid" : { },
"identityDoc" : [ { } ],
"individual" : { },
"infant" : { },
"langUsage" : [ { } ],
"loyaltyProgramAccount" : [ { } ],
"offeredService" : [ { } ],
"org" : { },
"pax" : { },
"paxGroup" : { },
"paxIdentifier" : "string",
"paxSegment" : [ { } ],
"profileConsentInd" : "boolean",
"profileIdentifierText" : "string",
"promotion" : { },
"ptcCode" : "string",
"redressCase" : [ { } ],
"remark" : [ { } ],
"service" : [ { } ],
"ticketDocInfo" : { }
},
"suffixName" : "string",
"surname" : "string",
"titleName" : "string",
"typeCode" : {
"identityDocTypeCodeEnum" : { }
},
"visa" : [ {
"country" : { },
"countrySubDivision" : [ { } ],
"enterBeforeDate" : "string",
"entryQty" : "number",
"identityDoc" : { },
"stayDuration" : "string",
"typeCode" : "string",
"visaIdentifier" : "string"
} ]
}