Comment on page
SouthAfricaIDCardModel
A class derived from IDCardModel containing details specific to the South Africa ID card document
@objc final public class SouthAfricaIDCardModel : IDCardModel {
@objc override final public var fullName: String? { get }
@objc final public var surname: String? { get }
@objc final public var names: 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 countryOfBirth: String? { get }
@objc final public var citizenship: CitizenshipType { get }
@objc final public var dateIssued: Date? { get }
@objc final public var rsaCode: String? { get }
@objc final public var cardNumber: String? { 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 names and surname of the subject as found on the ID card document. | Barcode | |
String? | The surname of the subject as found on the ID card document. | Barcode | |
String? | The names of the subject as found on the ID card document. | Barcode | |
Date? | The date of birth for the South African identity number. | Barcode | |
The sex for the South African identity number. | Barcode | ||
The citizenship type for the South African identity number. | Barcode | ||
Int | The A digit for the South African identity number. | Barcode | |
Int | The check digit for the South African identity number. | Barcode | |
String? | The country of birth of the subject as found on the ID card document. | Barcode | |
The citizenship of the subject as found on the ID card document. | Barcode | ||
Date? | The date issued of the ID card document. | Barcode | |
String? | The RSA code of the ID card document. | Barcode | |
String? | The card number of the ID card document. | Barcode |
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 |
Identity number |
As explained in Validation & Verification the following fields are verified across the front and back components of the document.
Value | Source |
Identity number | Front: OCR Back: Barcode |
@objc override final public var fullName: String? { get }
Example:
"JOHN DOE"
The names and surname of the subject as found on the ID card document.
@objc final public var surname: String? { get }
Example:
"DOE"
The surname of the subject as found on the ID card document.
@objc final public var names: String? { get }
Example:
"JOHN"
The names of the subject as found on the ID card 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 countryOfBirth: String? { get }
Example:
"RSA"
The country of birth of the subject as found on the ID card document.
Example:
CitizenshipType.Citizen
The citizenship of the subject as found on the ID card document.
@objc final public var dateIssued: Date? { get }
Example:
2005/01/01
The date issued of the ID card document.
@objc final public var rsaCode: String? { get }
Example:
"01234"
The RSA code of the ID card document.
@objc final public var cardNumber: String? { get }
Example:
"0123456789"
The card number of the ID card document.
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