MBMrzResult

@interface MBMrzResult : NSObject<MBAgeResult>

MB_INIT_UNAVAILABLE

/**
 * Returns the MRTD document type of recognized document.
 */
@property (nonatomic, assign, readonly) MBMrtdDocumentType documentType;

/**
 * Returns the primary indentifier. If there is more than one component, they are separated with space.
 */
@property (nonatomic, strong, readonly) NSString *primaryID;

/**
 * Returns the secondary identifier. If there is more than one component, they are separated with space.
 */
@property (nonatomic, strong, readonly) NSString *secondaryID;

/**
 * Returns three-letter or two-letter code which indicate the issuing State. Three-letter codes are based
 * on Aplha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter
 * codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.
 */
@property (nonatomic, strong, readonly) NSString *issuer;

/**
 * Returns issuer name
*/
@property (nonatomic, strong, readonly) NSString *issuerName;

/**
 * Returns holder's date of birth
 */
@property (nonatomic, strong, readonly) MBDateResult *dateOfBirth;

/**
 * Returns document number. Document number contains up to 9 characters.
 * Element does not exist on US Green Card. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *documentNumber;

/**
 * Returns nationality of the holder represented by a three-letter or two-letter code. Three-letter
 * codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain
 * States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with
 * extensions for certain States.
 */
@property (nonatomic, strong, readonly) NSString *nationality;

/**
 * Returns gender of the card holder. Gender is specified by use of the single initial, capital letter F for female,
 * M for male or ; for unspecified.
 */
@property (nonatomic, strong, readonly) NSString *gender;

/**
 * Returns 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 ;.
 */
@property (nonatomic, strong, readonly) NSString *documentCode;

/**
 * Returns date of expiry
 */
@property (nonatomic, strong, readonly) MBDateResult *dateOfExpiry;

/**
 * Returns first optional data. Returns empty string if not available.
 * Element does not exist on US Green Card. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *opt1;

/**
 * Returns second optional data. Returns empty string if not available.
 * Element does not exist on US Green Card. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *opt2;

/**
 * Returns alien number. Returns empty string if not available.
 * Exists only on US Green Cards. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *alienNumber;

/**
 * Returns application receipt number. Returns empty string if not available.
 * Exists only on US Green Cards. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *applicationReceiptNumber;

/**
 * Returns immigrant case number. Returns empty string if not available.
 * Exists only on US Green Cards. To see which document was scanned use documentType.
 */
@property (nonatomic, strong, readonly) NSString *immigrantCaseNumber;

/**
 * Returns the entire Machine Readable Zone text from ID. This text is usually used for parsing
 * other elements.
 * NOTE: This string is available only if OCR result was parsed successfully.
 */
@property (nonatomic, strong, readonly) NSString *mrzText;

/**
 * Returns true if Machine Readable Zone has been parsed, false otherwise.
 */
@property (nonatomic, assign, readonly) BOOL isParsed;

/**
 * Returns true if all check digits inside MRZ are correct, false otherwise.
 */
@property (nonatomic, assign, readonly) BOOL isVerified;

/**
 * Sanitized field opt1
 */
@property (nonatomic, strong, readonly) NSString *sanitizedOpt1;

/**
 * Sanitized field opt2
 */
@property (nonatomic, strong, readonly) NSString *sanitizedOpt2;

/**
 * Sanitized field nationality
 */
@property (nonatomic, strong, readonly) NSString *sanitizedNationality;

/**
 * Sanitized field issuer
 */
@property (nonatomic, strong, readonly) NSString *sanitizedIssuer;

/**
 * Sanitized document code
 */
@property (nonatomic, strong, readonly) NSString *sanitizedDocumentCode;

/**
 * Sanitized document number
 */
@property (nonatomic, strong, readonly) NSString *sanitizedDocumentNumber;

/**
 * Returns name of nationality 
*/
@property (nonatomic, strong, readonly) NSString *nationalityName;

@end

Undocumented

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    MB_INIT_UNAVAILABLE
  • Returns the MRTD document type of recognized document.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly)
        MBMrtdDocumentType documentType;

    Swift

    var documentType: MBMrtdDocumentType { get }
  • Returns the primary indentifier. If there is more than one component, they are separated with space.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull primaryID;

    Swift

    var primaryID: String { get }
  • Returns the secondary identifier. If there is more than one component, they are separated with space.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull secondaryID;

    Swift

    var secondaryID: String { get }
  • Returns three-letter or two-letter code which indicate the issuing State. Three-letter codes are based on Aplha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull issuer;

    Swift

    var issuer: String { get }
  • Returns issuer name

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull issuerName;

    Swift

    var issuerName: String { get }
  • Returns holder’s date of birth

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) MBDateResult *_Nonnull dateOfBirth;

    Swift

    var dateOfBirth: MBDateResult { get }
  • Returns document number. Document number contains up to 9 characters. Element does not exist on US Green Card. To see which document was scanned use documentType.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull documentNumber;

    Swift

    var documentNumber: String { get }
  • Returns nationality of the holder represented by a three-letter or two-letter code. Three-letter codes are based on Alpha-3 codes for entities specified in ISO 3166-1, with extensions for certain States. Two-letter codes are based on Aplha-2 codes for entities specified in ISO 3166-1, with extensions for certain States.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull nationality;

    Swift

    var nationality: String { get }
  • Returns gender of the card holder. Gender is specified by use of the single initial, capital letter F for female, M for male or ; for unspecified.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull gender;

    Swift

    var gender: String { get }
  • Returns 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 (nonatomic, strong, readonly) NSString *_Nonnull documentCode;

    Swift

    var documentCode: String { get }
  • Returns date of expiry

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) MBDateResult *_Nonnull dateOfExpiry;

    Swift

    var dateOfExpiry: MBDateResult { get }
  • Returns first optional data. Returns empty string if not available. Element does not exist on US Green Card. To see which document was scanned use documentType.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull opt1;

    Swift

    var opt1: String { get }
  • Returns second optional data. Returns empty string if not available. Element does not exist on US Green Card. To see which document was scanned use documentType.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull opt2;

    Swift

    var opt2: String { get }
  • Returns alien number. Returns empty string if not available. Exists only on US Green Cards. To see which document was scanned use documentType.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull alienNumber;

    Swift

    var alienNumber: String { get }
  • Returns application receipt number. Returns empty string if not available. Exists only on US Green Cards. To see which document was scanned use documentType.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly)
        NSString *_Nonnull applicationReceiptNumber;

    Swift

    var applicationReceiptNumber: String { get }
  • Returns immigrant case number. Returns empty string if not available. Exists only on US Green Cards. To see which document was scanned use documentType.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull immigrantCaseNumber;

    Swift

    var immigrantCaseNumber: String { get }
  • Returns the entire Machine Readable Zone text from ID. This text is usually used for parsing other elements. NOTE: This string is available only if OCR result was parsed successfully.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull mrzText;

    Swift

    var mrzText: String { get }
  • Returns true if Machine Readable Zone has been parsed, false otherwise.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) BOOL isParsed;

    Swift

    var isParsed: Bool { get }
  • Returns true if all check digits inside MRZ are correct, false otherwise.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) BOOL isVerified;

    Swift

    var isVerified: Bool { get }
  • Sanitized field opt1

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull sanitizedOpt1;

    Swift

    var sanitizedOpt1: String { get }
  • Sanitized field opt2

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull sanitizedOpt2;

    Swift

    var sanitizedOpt2: String { get }
  • Sanitized field nationality

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull sanitizedNationality;

    Swift

    var sanitizedNationality: String { get }
  • Sanitized field issuer

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull sanitizedIssuer;

    Swift

    var sanitizedIssuer: String { get }
  • Sanitized document code

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull sanitizedDocumentCode;

    Swift

    var sanitizedDocumentCode: String { get }
  • Sanitized document number

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly)
        NSString *_Nonnull sanitizedDocumentNumber;

    Swift

    var sanitizedDocumentNumber: String { get }
  • Returns name of nationality

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull nationalityName;

    Swift

    var nationalityName: String { get }