Skip to main content

Document

A structured representation of an official travel or identity document associated with a traveler. The document entity captures validated and extracted identity attributes from documents such as passports, ID cards, visas, or residence permits.

The document acts as a trusted source of biographic data within border control processes — enabling reuse of document data across enrollment, verification, and operational workflows while maintaining traceability to the original capture.

Attributes

FieldTypeOptionalityFormat / LengthSourceNotes
documentIdUUID / stringMandatory36 chars if UUIDSystemInternal immutable identifier
travellerIdUUID / stringMandatory36 chars if UUIDSystemLink to Traveler aggregate
firstNamesstring (Unicode)Mandatory for named documents1..100ICAODocument-fidelity name (better than separate first/middle for some scripts)
middleNamestring (Unicode)Optional1..100TISOptional convenience split; not always reliably separable from ICAO naming
lastNamestring (Unicode)Mandatory for named documents1..100ICAODocument-native holder name, not only traveler-normalized name
dateOfBirthdateRecommendedYYYY-MM-DDICAO / EESCommon document field; normalize from MRZ where available
addressstructured / stringOptionalup to 250 if flatTIS / national-docNot generic ICAO passport minimum; do not require for all document types
nationalityISO 3166-1 alpha-3Conditionalexactly 3ICAOStandard in MRZ for passport / national document
documentTypeenumMandatorysee belowICAO / TIS / EESDistinguishes passport, visa, residence permit, ID card, other
documentNumberstringMandatory1..20 uppercase alphanumericICAO / EESTIS identifier for border processes
issuingCountryISO 3166-1 alpha-3Mandatoryexactly 3ICAOICAO MRZ uses 3-letter issuing State / organization codes
issueDatedateConditionalYYYY-MM-DDICAO / TISNot always available in all capture contexts; highly useful when present
expiryDatedateConditionalYYYY-MM-DDICAO / EESImportant operationally for validity checks
documentStatusenumMandatoryValid, Expired, Revoked, FlaggedTISLifecycle / operational status
isPrimarybooleanRecommendedtrue / falseTISAt most one primary document per traveler
mrzPayloadstring / structuredRecommended where MRZ existsraw + parsedICAOKeep raw MRZ payload and the parsed fields
storedModalitiesobject / referencesOptionaln/aICAO eMRTD / EES / TISReference biometric records — do not embed raw blobs in the document object

Enum: documentType

Passport (Ordinary), Passport (Diplomatic), NationalID, Visa, ResidencePermit, Other

See also