UnitedKingdomPassportModel

A class derived from PassportModel containing details specific to the United Kingdom passport document

Declaration

@objc final public class UnitedKingdomPassportModel : PassportModel {
    @objc final public var mrzLine1: String? { get }
    @objc final public var mrzLine2: String? { get }
    @objc final public var passportNumberCheckDigit: Int { get }
    @objc final public var dateOfBirthCheckDigit: Int { get }
    @objc final public var dateOfExpiryCheckDigit: Int { get }
    @objc final public var optionalData: String? { get }
    @objc final public var optionalDataCheckDigit: Int { get }
    @objc final public var compositeCheckDigit: Int { get }
    
    override final public func encode(to encoder: Encoder) throws
}

Only relevant details are shown, boilerplate or standard Swift generated code is omitted

Summary

Public variables

Name	Type	Description	Data source
mrzLine1	String?	The top MRZ line of the passport document.	MRZ
mrzLine2	String?	The bottom MRZ line of the passport document.	MRZ
passportNumberCheckDigit	Int	The check digit for passportNumber.	MRZ
dateOfBirthCheckDigit	Int	The check digit for dateOfBirth.	MRZ
dateOfExpiryCheckDigit	Int	The check digit for dateOfExpiry.	MRZ
optionalData	String?	Uncategorized data found on the passport document.	MRZ
optionalDataCheckDigit	Int	The check digit for optionalData.	MRZ
compositeCheckDigit	Int	The check digit for the entire MRZ.	MRZ

Public methods

Signature	Return Type	Description
encode(to encoder: Encoder)	Void	Encodes the model using the encoder provided. Used to convert the model to JSON.

Validation

The following validation and verification applies to this document:

Check digit validation

Value	Validation type
Date of birth	Check digit using MRP Checksum calculation algorithm.
Date of expiry	Check digit using MRP Checksum calculation algorithm.
Optional data	Check digit using MRP Checksum calculation algorithm.
MRZ line 2 composite	Check digit using MRP Checksum calculation algorithm.
Passport number	Check digit using MRP Checksum calculation algorithm.

Public variables

mrzLine1

@objc final public var mrzLine1: String? { get }

Example: "P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<"

The top MRZ line of the passport document.

mrzLine2

@objc final public var mrzLine2: String? { get }

Example: "L898902C36UTO7408122F1204159ZE184226B<<<<<10"

The bottom MRZ line of the passport document.

passportNumberCheckDigit

@objc final public var passportNumberCheckDigit: Int { get }

Example: 6

The check digit for passportNumber.

dateOfBirthCheckDigit

@objc final public var dateOfBirthCheckDigit: Int { get }

Example: 2

The check digit for dateOfBirth.

dateOfExpiryCheckDigit

@objc final public var dateOfExpiryCheckDigit: Int { get }

Example: 9

The check digit for dateOfExpiry.

optionalData

@objc final public var optionalData: String? { get }

Example: "ZE184226B"

Uncategorized data found on the passport document.

optionalDataCheckDigit

@objc final public var optionalDataCheckDigit: Int { get }

Example: 1

The check digit for optionalData.

compositeCheckDigit

@objc final public var compositeCheckDigit: Int { get }

Example: 0

The check digit for the entire MRZ.

Public methods

encode(to encoder: Encoder)

override final public func encode(to encoder: Encoder) throws

This function also calls its super function

Encodes the model using the encoder provided. Used to convert the model to JSON.

See also

• PassportModel