ALMRZIdentification Class Reference

Inherits from NSObject
Declared in ALMRZIdentification.h

  documentType

@property (nonnull, nonatomic, strong, readonly) NSString *documentType

  documentNumber

@property (nonnull, nonatomic, strong, readonly) NSString *documentNumber

  surNames

@property (nonnull, nonatomic, strong, readonly) NSString *surNames

  givenNames

@property (nonnull, nonatomic, strong, readonly) NSString *givenNames

  issuingCountryCode

@property (nonnull, nonatomic, strong, readonly) NSString *issuingCountryCode

  nationalityCountryCode

@property (nonnull, nonatomic, strong, readonly) NSString *nationalityCountryCode

  dayOfBirth

@property (nonnull, nonatomic, strong, readonly) NSString *dayOfBirth

  expirationDate

@property (nonnull, nonatomic, strong, readonly) NSString *expirationDate

  sex

@property (nonnull, nonatomic, strong, readonly) NSString *sex

  checkdigitNumber

@property (nonnull, nonatomic, strong, readonly) NSString *checkdigitNumber

  checkdigitExpirationDate

@property (nonnull, nonatomic, strong, readonly) NSString *checkdigitExpirationDate

  checkdigitDayOfBirth

@property (nonnull, nonatomic, strong, readonly) NSString *checkdigitDayOfBirth

  checkdigitFinal

@property (nonnull, nonatomic, strong, readonly) NSString *checkdigitFinal

  personalNumber

@property (nonnull, nonatomic, strong, readonly) NSString *personalNumber

  checkDigitPersonalNumber

@property (nonnull, nonatomic, strong, readonly) NSString *checkDigitPersonalNumber

  personalNumber2

@property (nonnull, nonatomic, strong, readonly) NSString *personalNumber2

  address

@property (nullable, nonatomic, strong, readonly) NSString *address

  issuingDate

@property (nullable, nonatomic, strong, readonly) NSString *issuingDate

  issuingDateObject

@property (nullable, nonatomic, strong, readonly) NSDate *issuingDateObject

  expirationDateObject

@property (nullable, nonatomic, strong, readonly) NSDate *expirationDateObject

  dayOfBirthDateObject

@property (nullable, nonatomic, strong, readonly) NSDate *dayOfBirthDateObject

  MRZString

@property (nonnull, nonatomic, strong, readonly) NSString *MRZString

  faceImage

@property (nullable, nonatomic, strong) UIImage *faceImage

– initWithDocumentType:issuingCountryCode:nationalityCountryCode:surNames:givenNames:documentNumber:checkDigitNumber:dayOfBirth:checkDigitDayOfBirth:sex:expirationDate:checkDigitExpirationDate:personalNumber:checkDigitPersonalNumber:checkDigitFinal:personalNumber2:address:issuingDate:MRZString:

Initializes a ALIdentification object. This object is used to carry the scanned values.

- (instancetype _Nullable)initWithDocumentType:(NSString *_Nonnull)documentType issuingCountryCode:(NSString *_Nonnull)issuingCountryCode nationalityCountryCode:(NSString *_Nonnull)nationalityCountryCode surNames:(NSString *_Nonnull)surNames givenNames:(NSString *_Nonnull)givenNames documentNumber:(NSString *_Nonnull)documentNumber checkDigitNumber:(NSString *_Nonnull)checkDigitNumber dayOfBirth:(NSString *_Nonnull)dayOfBirth checkDigitDayOfBirth:(NSString *_Nonnull)checkDigitDayOfBirth sex:(NSString *_Nonnull)sex expirationDate:(NSString *_Nonnull)expirationDate checkDigitExpirationDate:(NSString *_Nonnull)checkdigitExpirationDate personalNumber:(NSString *_Nonnull)personalNumber checkDigitPersonalNumber:(NSString *_Nonnull)checkDigitPersonalNumber checkDigitFinal:(NSString *_Nonnull)checkDigitFinal personalNumber2:(NSString *_Nonnull)personalNumber2 address:(NSString *_Nullable)address issuingDate:(NSString *_Nullable)issuingDate MRZString:(NSString *_Nonnull)MRZString

Parameters

documentType

The type of the document that was read. (ID/P)

issuingCountryCode

The issuing country code of the document.

nationalityCountryCode

The nationality country code of the document.

surNames

All the surNames of the person separated by whitespace.

givenNames

All the given names of the person separated by whitespace.

documentNumber

Passport number or document number.

checkDigitNumber

Check digit for the document number.

dayOfBirth

The day of birth.

checkDigitDayOfBirth

Check digit for the day of birth.

sex

The gender of the person

expirationDate

The expiration date of the passport / document.

personalNumber

Personal Number on the document. Is nil on many passports / documents.

checkDigitPersonalNumber

CheckDigit for the personal number. Is nil or 0 when no personal number is used. Is also nil on none passport documents.

checkDigitFinal

On passports checkdigit over passport number, passport number checkdigit, date of birth, date of birth checkdigit, expiration date, expiration date checkdigit, personal number and personal number checkdigit. On other travel documents over document number, document number checkdigit, personal number, date of birth, date of birth checkdigit, expiration date and expiration date checkdigit.

personalNumber2

Optional data at the discretion of the issuing state. Only available in TD1 sized MROTDs. Might contain additional information.

address

Optional data which contains the data of the address field on a german ID.

issuingDate

Optional data which contains the data of the issuing date field, which is outside the MRZ field

MRZString

Contains all Information found in the MRZ as string.

checkDigitExpirationDate

Check digit for the expiration date.

Return Value

A new ALIdentification object

Declared In

ALMRZIdentification.h