Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Structure

FieldTypeRequiredDescription
id
true
documentTypeDocumentTypetrueType of document
documentNumberStringtrueIdentificative number of the document of the guest.
givenNameStringtrueName of the guest.
middleNameStringtrueMiddle name of the guest.
surnameStringtrueSurname (second name) of the guest.

genderType

GenderTypetrueGender of the guest.

birthDate

LocalDatetrueBirth date of the guest as is on the document.
birthCountryCodeStringtrueBirth country of the guest as is on the document. ISO 3166-1 alpha-2
birthPlaceString
Name of the city/town where the guest was born.
effectiveDateLocalDatetrueDate when the document was created.
expireDateLocalDatetrueDate when the document expires.
streetStringtrueStreet of the residence of the guest as is on the document.
cityStringtrueCity of the guest as is on the document.
stateProvNameString
State or province of the guest as is on the document.
stateProvCodeString
ISO 3166-2
countryCodeString
Country of the guest as is on the document. ISO 3166-1 alpha-2
postalCodeString
CP of the guest as is on the document.
nationalityCountryCodeString
Country of the nationality of the guest. ISO 3166-1 alpha-2
countryOfIssuanceCodeString
Country of issuance of the document of the guest. ISO 3166-1 alpha-2
ocrString

emailString

phoneNumberString

JSON representation

{
	"id": 1,
	"documentType": {
		"id": 2,
		"code": "2",
		"name": "Passport"
	},
	"documentNumber": "MNZLDtSw",
	"givenName": "Jeremy",
	"middleName": "Stéphanie",
	"surName": "Gardner",
	"genderType": {
		"id": 2,
		"code": "F",
		"name": "Female"
	},
	"birthDate": "2018-04-12T18:13:50.710Z",
	"birthCountryCode": "ES",
	"birthPlace": "Waterbury",
	"effectiveDate": "2018-04-12T18:13:50.710Z",
	"expireDate": "2018-04-12T18:13:50.710Z",
	"street": "03 Rusk Park",
	"city": "Waterbury",
	"stateProvName": "Barcelona",
	"stateProvCode": "ES-B",
	"countryCode": "ES",
	"postalCode": "6726",
	"nationalityCountryCode": "ES",
	"ocr": null,
	"email": "phill8m@usnews.com",
	"phoneNumber": "1-(203)205-9014"
}
  • No labels