Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Structure

Excerpt


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.
birthCountrybirthCountryCodeCountryStringtrueBirth 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.stateProvStateProvcountry
CountrystateProvCodeString
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.
nationalityCountrynationalityCountryCodeCountryString
Country of the nationality of the guest. ISO 3166-1 alpha-2
ocrString

emailString

phoneNumberString



JSON representation

Code Block
languagepowershell
themeDJango
{
	"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",
	"birthCountrybirthCountryCode": {
		"idES": 231,
		"code": "VEN",
		"name": "VENEZUELA"
	},
	"birthPlace": "Waterbury",
	"effectiveDate": "2018-04-12T18:13:50.710Z",
	"expireDate": "2018-04-12T18:13:50.710Z",
	"street": "03 Rusk Park",
	"city": "Waterbury",
	"stateProvName": "ConnecticutBarcelona",
	"stateProvstateProvCode": null,
	"country": {
		"id": 231"ES-B",
		"codecountryCode": "VEN",
		"name": "VENEZUELA"
	}ES",
	"postalCode": "6726",
	"nationalityCountrynationalityCountryCode": {
		"id": 231,
		"code": "VEN",
		"name": "VENEZUELA"
	}ES",
	"ocr": null,
	"email": "phill8m@usnews.com",
	"phoneNumber": "1-(203)205-9014"
}