Package-level declarations

Types

Link copied to clipboard
data class CheckDigit(val isValid: Boolean, val value: Char)

Represents a single check digit extracted from a Machine Readable Zone (MRZ) according to the ICAO Doc 9303.

Link copied to clipboard
data class Date(val year: Int, val month: Int, val day: Int)

Represents a date extracted from a Machine Readable Zone (MRZ) according to the ICAO Doc 9303.

Link copied to clipboard

Machine Readable Zone (MRZ). It contains a travel document type and the parsed content in one of the TD1, TD2 or TD3.

Link copied to clipboard
data class StringPosition(val lineIndex: Int, val startIndex: Int, val endIndex: Int)

Represents the position of a string within a Machine Readable Zone (MRZ) line according to the ICAO Doc 9303.

Link copied to clipboard
data class Td1MachineReadableZone(val documentCode: Element, val issuingStateOrOrganization: Element, val documentNumber: ElementWithCheckDigit, val dateOfBirth: DateElementWithCheckDigit, val sex: Element, val dateOfExpiry: DateElementWithCheckDigit, val nationality: Element, val name: NameElement, val optionalData: List<Element>, val compositeCheckDigit: CheckDigit)

Represents the Machine Readable Zone (MRZ) data extracted from a Travel Document Type 1 (TD1) according to the ICAO Doc 9303.

Link copied to clipboard
data class Td2MachineReadableZone(val documentCode: Element, val issuingStateOrOrganization: Element, val name: NameElement, val documentNumber: ElementWithCheckDigit, val nationality: Element, val dateOfBirth: DateElementWithCheckDigit, val sex: Element, val dateOfExpiry: DateElementWithCheckDigit, val optionalData: Element?, val compositeCheckDigit: CheckDigit)

Represents the Machine Readable Zone (MRZ) data extracted from a Travel Document Type 2 (TD2) according to the ICAO Doc 9303.

Link copied to clipboard
data class Td3MachineReadableZone(val documentCode: Element, val issuingStateOrOrganization: Element, val name: NameElement, val passportNumber: ElementWithCheckDigit, val nationality: Element, val dateOfBirth: DateElementWithCheckDigit, val sex: Element, val dateOfExpiry: DateElementWithCheckDigit, val personalNumberOrOtherOptionalData: ElementWithCheckDigit, val compositeCheckDigit: CheckDigit)

Represents the Machine Readable Zone (MRZ) data extracted from a Travel Document Type 3 (TD3) according to the ICAO Doc 9303.

Link copied to clipboard

Travel document type according to ICAO Doc 9303.