MBLegacyMRTDRecognizerResult


@interface MBLegacyMRTDRecognizerResult : MBLegacyRecognizerResult

Undocumented

  • Undocumented

    Declaration

    Objective-C

    MB_INIT_UNAVAILABLE

  • Three-letter code which indicate the issuing State. Three-letter codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain States.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *issuer;

    Swift

    var issuer: String? { get }

  • Unique number of the document. Document number contains up to 9 characters. Element does not exist on US Green Card. To see which document was scanned use documentType property.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *documentNumber;

    Swift

    var documentNumber: String? { get }

  • The document code. Document code contains two characters. For MRTD the first character shall be A, C or I. The second character shall be discretion of the issuing State or organization except that V shall not be used, and C shall not be used after A except in the crew member certificate. On machine-readable passports (MRP) first character shall be P to designate an MRP. One additional letter may be used, at the discretion of the issuing State or organization, to designate a particular MRP. If the second character position is not used for this purpose, it shall be filled by the filter character <.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *documentCode;

    Swift

    var documentCode: String? { get }

  • Date of expiry of the document in format YYMMDD.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *rawDateOfExpiry;

    Swift

    var rawDateOfExpiry: String? { get }

  • Date of expiry of the document.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *dateOfExpiry;

    Swift

    var dateOfExpiry: Date? { get }

  • Returns the primary indentifier. If there is more than one component, they are separated with space.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *primaryId;

    Swift

    var primaryId: String? { get }

    Return Value

    primary id of a card holder.

  • Returns the secondary identifier. If there is more than one component, they are separated with space.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *secondaryId;

    Swift

    var secondaryId: String? { get }

    Return Value

    secondary id of a card holder

  • Holder’s date of birth in format YYMMDD.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *rawDateOfBirth;

    Swift

    var rawDateOfBirth: String? { get }

  • Holder’s date of birth.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *dateOfBirth;

    Swift

    var dateOfBirth: Date? { get }

  • Nationality of the holder represented by a three-letter code. Three-letter codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain States.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *nationality;

    Swift

    var nationality: String? { get }
  • sex

    Sex of the card holder. Sex is specified by use of the single initial, capital letter F for female, M for male or < for unspecified.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *sex;

    Swift

    var sex: String? { get }

  • First optional data. Returns nil or empty string if not available. Element does not exist on US Green Card. To see which document was scanned use documentType property.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *opt1;

    Swift

    var opt1: String? { get }

  • Second optional data. Returns nil or empty string if not available. Element does not exist on Passports and Visas. To see which document was scanned use documentType property.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *opt2;

    Swift

    var opt2: String? { get }

  • The entire Machine Readable Zone text from ID. This text is usually used for parsing other elements.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *mrzText;

    Swift

    var mrzText: String? { get }

  • Boolean value which denotes that MRTD result is successfully parsed. When the result is parsed, all properties below are present.

    If in the PPMrtdRecognizerSettings you specified allowUnparsedResults = YES, then it can happen that MRTDRecognizerResult is not parsed. When this happens, this property will be equal to YES.

    In that case, you can use rawOcrResult property to obtain the raw result of the OCR process, so you can implement MRTD parsing in your application.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL mrzParsed;

    Swift

    var mrzParsed: Bool { get }

    Return Value

    YES if MRTD Recognizer result was successfully parsed and all the fields are extracted. NO otherwise.

  • YES if all check digits inside MRZ are correct, NO otherwise. More specifically, YES if MRZ complies with ICAO Document 9303 standard, NO otherwise.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL mrzVerified;

    Swift

    var mrzVerified: Bool { get }