multipaz-mrtd-reader/org.multipaz.mrtd

Package-level declarations

Types

data class MrtdAccessDataCan(val canCode: String) : MrtdAccessData

data class MrtdAccessDataMrz(val documentNumber: String, val dateOfBirth: String, val dateOfExpiration: String) : MrtdAccessData

Represents a small set of data that is typically captured by OCR from Machine Readable Zone (MRZ) on a passport (or other MRTD).

MrtdAccessDataPin

data class MrtdAccessDataPin(val pinCode: String) : MrtdAccessData

MrtdDecodedData

data class MrtdDecodedData(val firstName: String, val firstNameComponents: List<String>, val lastName: String, val issuingState: String, val nationality: String, val gender: String, val documentCode: String, val documentNumber: String, val dateOfBirth: String, val dateOfExpiry: String, val personalNumber: String?, val optionalData1: String?, val optionalData2: String?, val photoMediaType: String?, val photo: ByteString?, val signatureMediaType: String?, val signature: ByteString?)

Data read from the passport or ID card.

MrtdMrzChecksumValidator

class MrtdMrzChecksumValidator(checksumRanges: List<MrtdMrzChecksumValidator.Range>, checksumDigitIndex: Int)

Validates that a data field in Machine Readable Zone (MRZ) was scanned and OCRed correctly from an ICAO Machine-readable Travel Document (MRTD).

MrtdNfc

sealed class MrtdNfc

A class that provides a namespace for Status and its subclasses (which act a bit like an enum).

MrtdNfcChipAccess

class MrtdNfcChipAccess(shouldCheckMac: Boolean)

Implements Chip Access Procedure (see ICAO 9303 part 11, Section 4.2), establishing encrypted connection to the chip. Emits MrtdNfc.Status as the reading progresses.

MrtdNfcData