Merge pull request #97 from BlinkID/feature/v2.11.0

Feature/v2.11.0

CHANGELOG.md

@@ -1,3 +1,20 @@
+## 2.11.0
+
+- Updates and additions
+    - Added Austrian Passport Recognizer `PPAusPassportRecognizerResult` and `PPAusPassportRecognizerSettings`
+    - Added Swiss Passport Recognizer `PPSwissPassportRecognizerResult` and `PPSwissPassportRecognizerSettings`
+    - Added support for scanning MRZ on Mexican voters card
+    - Added support for reading Croatian ID with permanent DateOfExpiry in `PPCroIDFrontRecognizerResult` and `PPCroIDCombinedRecognizerResult` with BOOL property `isDocumentDateOfExpiryPermanent`
+    - Added combining data from MRZ and fields in Austrian passport through `PPAusIDCombinedRecognizerResult` and `PPAusIDCombinedRecognizerSettings`
+
+- Bugfixes:
+    - Fixed crash which sometimes happened while scanning MRTD documents
+
+- Improvements in ID scanning performance:
+    - Improved scanning of IKad addresses
+    - Improved reading of Croatian ID Address field
+    - Improved reading of Croatian ID IssuedBy field 
+
 ## 2.10.0
 
 - Updates and additions:

MicroBlink.framework/Headers/PPAusPassportRecognizerResult.h

@@ -0,0 +1,87 @@
+//
+//  PPAusPassportRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 24/07/2017.
+//
+//
+
+#import "PPBlinkOcrRecognizerResult.h"
+
+/**
+ * Class representing values obtained when scanning of Austrian Passport
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPAusPassportRecognizerResult : PPBlinkOcrRecognizerResult
+
+/**
+ * The surname of the Austrian Passport owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *lastName;
+
+/**
+ * The name of the Austrian Passport owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *firstName;
+
+/**
+ * The nationality of the Austrian Passport owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *nationality;
+
+/**
+ * The place of birth of the Austrian Passport owner
+ */
+@property (nonatomic, readonly, nullable) NSString *placeOfBirth;
+
+/**
+ * Raw date of issue, as written on the passport
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfIssue;
+
+/**
+ * Date of issue in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfIssue;
+
+/**
+ * Raw date of birth, as written on the passport
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfBirth;
+
+/**
+ * Date of birth in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfBirth;
+
+/**
+ * Raw date of expiry, as written on the passport
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfExpiry;
+
+/**
+ * Date of expiry in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfExpiry;
+
+/**
+ * Issuing authority of the Passport
+ */
+@property (nonatomic, readonly, nullable) NSString *authority;
+
+/**
+ * Number of the Passport
+ */
+@property (nonatomic, readonly, nullable) NSString *passportNumber;
+
+/**
+ * The sex of the Austrian Passport owner
+ */
+@property (nonatomic, readonly, nullable) NSString *sex;
+
+/**
+ * The height of the Austrian Passport owner
+ */
+@property (nonatomic, readonly, nullable) NSString *height;
+
+@end

MicroBlink.framework/Headers/PPAusPassportRecognizerSettings.h

@@ -0,0 +1,146 @@
+//
+//  PPAusPassportRecognizerSettings.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 24/07/2017.
+//
+//
+
+#import "PPRecognizerSettings.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Settings class for configuring Austrian Passport Recognizer.
+ *
+ * Austrian Passport recognizer is used for scanning Austrian Passport.
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPAusPassportRecognizerSettings : PPRecognizerSettings
+
+/**
+ * Name of the image sent to didOutputMetadata method of scanDelegate object that contains face.
+ * This image will be sent to scan delegate during recognition process if displaying of face image
+ * is enabled via displayFaceImage property and receiving of dewarpedImage in MetadataSettings is enabled.
+ */
++ (NSString *)ID_FACE;
+
+/**
+ * Name of the image sent to didOutputMetadata method of scanDelegate object that contains signature.
+ * This image will be sent to scan delegate during recognition process if displaying of face image
+ * is enabled via displaySignatureImage property and receiving of dewarpedImage in MetadataSettings is enabled.
+ */
++ (NSString *)ID_SIGNATURE;
+
+/**
+ * Name of the image sent to didOutputMetadata method of scanDelegate object that contains full document.
+ * This image will be sent to scan delegate during recognition process if displaying of full document image
+ * is enabled via displayFullDocumentImage property and receiving of dewarpedImage in MetadataSettings is enabled.
+ */
++ (NSString *)FULL_DOCUMENT_IMAGE;
+
+/**
+ * Defines if owner's surname should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractSurname;
+
+/**
+ * Defines if owner's name should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractName;
+
+/**
+ * Defines if owner's nationality should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractNationality;
+
+/**
+ * Defines if owner's place of birth should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractPlaceOfBirth;
+
+/**
+ * Defines if date of issue should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractDateOfIssue;
+
+/**
+ * Defines if date of birth should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractDateOfBirth;
+
+/**
+ * Defines if date of expiry should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractDateOfExpiry;
+
+/**
+ * Defines if authority should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractAuthority;
+
+/**
+ * Defines if passport number should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractPassportNumber;
+
+/**
+ * Defines if sex should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractSex;
+
+/**
+ * Defines if height should be extracted from Austrian Passport
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractHeight;
+
+/**
+ * Sets whether face image from ID card should be sent to didOutputMetadata method of scanDelegate object.
+ * If you want to recieve this image, be sure to enable dewarpedImage in MetadataSettings.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL returnFacePhoto;
+
+/**
+ * Sets whether signature image from ID card should be sent to didOutputMetadata method of scanDelegate object.
+ * If you want to recieve this image, be sure to enable dewarpedImage in MetadataSettings.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL returnSignaturePhoto;
+
+/**
+ * Sets whether full document image of ID card should be sent to didOutputMetadata method of scanDelegate object.
+ * If you want to recieve this image, be sure to enable dewarpedImage in MetadataSettings.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL returnFullDocumentPhoto;
+
+@end
+
+NS_ASSUME_NONNULL_END
+

MicroBlink.framework/Headers/PPBlinkIDRecognizers.h

@@ -14,6 +14,8 @@
 #import "PPAusIDBackRecognizerResult.h"
 #import "PPAusIDFrontRecognizerSettings.h"
 #import "PPAusIDFrontRecognizerResult.h"
+#import "PPAusPassportRecognizerSettings.h"
+#import "PPAusPassportRecognizerResult.h"
 #import "PPAusIDCombinedRecognizerSettings.h"
 #import "PPAusIDCombinedRecognizerResult.h"
 
@@ -107,9 +109,9 @@
 #import "PPSlovenianIDCombinedRecognizerSettings.h"
 #import "PPSlovenianIDCombinedRecognizerResult.h"
 
-// Aztec barcode recognition
-#import "PPAztecRecognizerSettings.h"
-#import "PPAztecRecognizerResult.h"
+// Switzerland
+#import "PPSwissPassportRecognizerSettings.h"
+#import "PPSwissPassportRecognizerResult.h"
 
 // Use all recognizers from BlinkInput
 #import "PPBlinkInputRecognizers.h"

MicroBlink.framework/Headers/PPCroIDBackRecognizerResult.h

@@ -34,4 +34,9 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 @property (nonatomic, readonly, nullable) NSDate *documentDateOfIssue;
 
+/**
+ * Check if date of expiry is permanent on the Croatian ID.
+ */
+@property (nonatomic, readonly) BOOL isDocumentDateOfExpiryPermanent;
+
 @end

MicroBlink.framework/Headers/PPCroIDCombinedRecognizerResult.h

@@ -49,6 +49,11 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 @property (nonatomic, readonly, nullable) NSDate *documentDateOfExpiry;
 
+/**
+ * Check if date of expiry is permanent on the Croatian ID.
+ */
+@property (nonatomic, readonly) BOOL isDocumentDateOfExpiryPermanent;
+
 /**
  * The address of the Croatian ID owner.
  */

MicroBlink.framework/Headers/PPCroIDFrontRecognizerResult.h

@@ -59,4 +59,9 @@ PP_CLASS_AVAILABLE_IOS(6.0)
  */
 @property (nonatomic, readonly, nullable) NSDate *documentDateOfExpiry;
 
+/**
+ * Check if date of expiry is permanent on the Croatian ID.
+ */
+@property (nonatomic, readonly) BOOL isDocumentDateOfExpiryPermanent;
+
 @end

MicroBlink.framework/Headers/PPSwissPassportRecognizerResult.h

@@ -0,0 +1,82 @@
+//
+//  PPSwissPassportRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 27/07/2017.
+//
+//
+
+#import "PPBlinkOcrRecognizerResult.h"
+
+/**
+ * Class representing values obtained when scanning of Swiss Passport
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPSwissPassportRecognizerResult : PPBlinkOcrRecognizerResult
+
+/**
+ * The surname of the Swiss Passport owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *lastName;
+
+/**
+ * The name of the Swiss Passport owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *firstName;
+
+/**
+ * The place of origin of the Swiss Passport owner
+ */
+@property (nonatomic, readonly, nullable) NSString *placeOfOrigin;
+
+/**
+ * Raw date of issue, as written on the passport
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfIssue;
+
+/**
+ * Date of issue in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfIssue;
+
+/**
+ * Raw date of birth, as written on the passport
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfBirth;
+
+/**
+ * Date of birth in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfBirth;
+
+/**
+ * Raw date of expiry, as written on the passport
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfExpiry;
+
+/**
+ * Date of expiry in NSDate object
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfExpiry;
+
+/**
+ * Issuing authority of the Passport
+ */
+@property (nonatomic, readonly, nullable) NSString *authority;
+
+/**
+ * Number of the Passport
+ */
+@property (nonatomic, readonly, nullable) NSString *passportNumber;
+
+/**
+ * The sex of the Swiss Passport owner
+ */
+@property (nonatomic, readonly, nullable) NSString *sex;
+
+/**
+ * The height of the Swiss Passport owner
+ */
+@property (nonatomic, readonly, nullable) NSString *height;
+
+@end