Comment on page
SouthAfricaPassportModel
A class derived from PassportModel containing details specific to the South Africa passport document
@objc final public class SouthAfricaPassportModel : 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 identityNumber: String? { get }
@objc final public var identityNumberDateOfBirth: Date? { get }
@objc final public var identityNumberSex: Sex { get }
@objc final public var identityNumberCitizenship: CitizenshipType { get }
@objc final public var identityNumberADigit: Int { get }
@objc final public var identityNumberCheckDigit: Int { get }
@objc final public var identityNumberPassportCheckDigit: 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
Name | Type | Description | Data source |
String? | The top MRZ line of the passport document. | MRZ | |
String? | The bottom MRZ line of the passport document. | MRZ | |
Int | MRZ | ||
Int | MRZ | ||
Int | MRZ | ||
String? | The identity number of the subject as found on the passport document. | MRZ | |
Date? | The date of birth for the South African identity number. | MRZ | |
The sex for the South African identity number. | MRZ | ||
The citizenship type for the South African identity number. | MRZ | ||
Int | The A digit for the South African identity number. | MRZ | |
Int | The check digit for the South African identity number. | MRZ | |
Int | MRZ | ||
Int | The check digit for the entire MRZ. | MRZ |
Signature | Return Type | Description |
Void | Encodes the model using the encoder provided. Used to convert the model to JSON. |
The following validation and verification applies to this document:
Value | Validation type |
Date of birth | |
Date of expiry | |
MRZ line 2 composite | |
Passport number | |
Identity number | |
Passport identity number (Optional data) |
@objc final public var mrzLine1: String? { get }
Example:
"P<UTOERIKSSON<<ANNA<MARIA<<<<<<<<<<<<<<<<<<<"
The top MRZ line of the passport document.
@objc final public var mrzLine2: String? { get }
Example:
"L898902C36UTO7408122F1204159ZE184226B<<<<<10"
The bottom MRZ line of the passport document.
@objc final public var passportNumberCheckDigit: Int { get }
Example:
6
@objc final public var dateOfBirthCheckDigit: Int { get }
Example:
2
@objc final public var dateOfExpiryCheckDigit: Int { get }
Example:
9
@objc final public var identityNumber: String? { get }
Example:
"8801235111088"
The identity number of the subject as found on the passport document.
@objc final public var identityNumberDateOfBirth: Date? { get }
Example:
1988/01/23
The date of birth for the South African identity number.
Example:
Sex.Male
The sex for the South African identity number.
Example:
CitizenshipType.Citizen
The citizenship type for the South African identity number.
@objc final public var identityNumberADigit: Int { get }
Example:
8
The A digit for the South African identity number.
@objc final public var identityNumberCheckDigit: Int { get }
Example:
8
The check digit for the South African identity number.
@objc final public var identityNumberPassportCheckDigit: Int { get }
Example:
0
@objc final public var compositeCheckDigit: Int { get }
Example:
0
The check digit for the entire MRZ.
override final public func encode(to encoder: Encoder) throws
Encodes the model using the encoder provided. Used to convert the model to JSON.
Last modified 1yr ago