Merge pull request #137 from BlinkID/feature/v2.16.0

Feature/v2.16.0

CHANGELOG.md

@@ -1,3 +1,25 @@
+## 2.16.0
+
+- Updates and additions
+	- added support for reading front side of Hong Kong ID - use `PPHongKongIDFrontRecognizerSettings`
+	- added support for reading front and back side of Colombian ID - use `PPColombiaIDFrontRecognizerSettings` and `PPColombiaIDBackRecognizerSettings`
+	- added support for reading front and back side of United Arab Emirates ID - use `PPUnitedArabEmiratesIDFrontRecognizerSettings` and `PPUnitedArabEmiratesIDBackRecognizerSettings`
+	- added support for reading front side of New Zealand drivers license - use `PPNewZealandDLFrontRecognizerSettings`
+
+- Improvements in ID scanning performance
+	- Improved reading of Belgium ID BRZ OPT2 field
+	- added support for reading Belgium MRZ with partial date of birth - `PPMrtdRecognizerSettings.allowUnverifiedResults` must be set to `true`
+	- added support for reading Kenya MRZ - `PPMrtdRecognizerSettings.allowUnverifiedResults` must be set to `true`
+	- improved `MyKadFrontSideRecognizer` and `MyTenteraRecognizer`:
+		- better reading of name field
+		- better reading of address field
+
+- Bugfixes	
+	- when setting DPI for full document image in concrete recognizer settings that has property `fullDocumentImageDPI`, exception is thrown if DPI value is not in the expected range `[100, 400]`
+	- fixed a crash in Templating API caused by using a `MultiDetector` with `DetectorRecognizer`
+        - fixed returning of face image when using `PPUnitedArabEmiratesIDFrontRecognizer`:
+            - fixed face image position
+
 ## 2.15.0
 
 - Updates and additions

MicroBlink.framework/Headers/PPAustraliaDLBackRecognizerSettings.h

@@ -57,6 +57,7 @@ PP_CLASS_AVAILABLE_IOS(6.0)
 
 /**
  * Property got setting DPI for full document images
+ * Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
  *
  * Default: 250.0
  */

MicroBlink.framework/Headers/PPAustraliaDLFrontRecognizerSettings.h

@@ -95,6 +95,7 @@ PP_CLASS_AVAILABLE_IOS(6.0)
 
 /**
  * Property got setting DPI for full document images
+ * Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
  *
  * Default: 250.0
  */

MicroBlink.framework/Headers/PPBlinkIDRecognizers.h

@@ -41,6 +41,12 @@
 #import "PPCzIDCombinedRecognizerSettings.h"
 #import "PPCzIDCombinedRecognizerResult.h"
 
+// Colombia
+#import "PPColombiaIDBackRecognizerSettings.h"
+#import "PPColombiaIDBackRecognizerResult.h"
+#import "PPColombiaIDFrontRecognizerSettings.h"
+#import "PPColombiaIDFrontRecognizerResult.h"
+
 // Document Face
 #import "PPDocumentFaceRecognizerSettings.h"
 #import "PPDocumentFaceRecognizerResult.h"
@@ -49,6 +55,10 @@
 #import "PPEudlRecognizerSettings.h"
 #import "PPEudlRecognizerResult.h"
 
+// Hong Kong
+#import "PPHongKongIDFrontRecognizerSettings.h"
+#import "PPHongKongIDFrontRecognizerResult.h"
+
 // Germany
 #import "PPGermanIDFrontRecognizerSettings.h"
 #import "PPGermanIDFrontRecognizerResult.h"
@@ -84,6 +94,10 @@
 #import "PPMrtdCombinedRecognizerResult.h"
 #import "PPMrzFilter.h"
 
+// New Zealand
+#import "PPNewZealandDLFrontRecognizerSettings.h"
+#import "PPNewZealandDLFrontRecognizerResult.h"
+
 // Indonesia
 #import "PPIndonesianIDFrontRecognizerSettings.h"
 #import "PPIndonesianIDFrontRecognizerResult.h"
@@ -148,6 +162,12 @@
 #import "PPUsdlRecognizerSettings.h"
 #import "PPUsdlRecognizerResult.h"
 
+// United Arab Emirates
+#import "PPUnitedArabEmiratesIDFrontRecognizerResult.h"
+#import "PPUnitedArabEmiratesIDFrontRecognizerSettings.h"
+#import "PPUnitedArabEmiratesIDBackRecognizerResult.h"
+#import "PPUnitedArabEmiratesIDBackRecognizerSettings.h"
+
 // Use all recognizers from BlinkInput
 #import "PPBlinkInputRecognizers.h"
 

MicroBlink.framework/Headers/PPColombiaIDBackRecognizerResult.h

@@ -0,0 +1,51 @@
+//
+//  PPColombiaIDBackRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 30/01/2018.
+//
+
+#import "PPRecognizerResult.h"
+
+/**
+ * Class representing values obtained when scanning back side of Colombia ID
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPColombiaIDBackRecognizerResult : PPRecognizerResult
+
+/**
+ * The first name of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *firstName;
+
+/**
+ * The last name of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *lastName;
+
+/**
+ * The sex of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *sex;
+
+/**
+ * The date of birth of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfBirth;
+
+/**
+ * The blood group of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *bloodGroup;
+
+/**
+ * The fingerprint of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSData *fingerprint;
+
+/**
+ * The document number of the Colombian ID card.
+ */
+@property (nonatomic, readonly, nullable) NSString *documentNumber;
+
+@end

MicroBlink.framework/Headers/PPColombiaIDBackRecognizerSettings.h

@@ -0,0 +1,37 @@
+//
+//  PPColombiaIDBackRecognizerSettings.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 30/01/2018.
+//
+
+#import "PPRecognizerSettings.h"
+
+/**
+ * Settings class for configuring Colombian Back ID Recognizer.
+ *
+ * Colombian Back ID recognizer is used for scanning back side of Colombian ID.
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPColombiaIDBackRecognizerSettings : PPRecognizerSettings
+
+/**
+ * Set this to YES to scan even barcode not compliant with standards
+ * For example, malformed PDF417 barcodes which were incorrectly encoded
+ *
+ * Use only if necessary because it slows down the recognition process
+ *
+ * Default: YES
+ */
+@property (nonatomic) BOOL scanUncertain;
+
+/**
+ * Set this to YES to scan barcodes which don't have quiet zone (white area) around it
+ *
+ * Use only if necessary because it slows down the recognition process
+ *
+ * Default: NO
+ */
+@property (nonatomic) BOOL allowNullQuietZone;
+
+@end

MicroBlink.framework/Headers/PPColombiaIDFrontRecognizerResult.h

@@ -0,0 +1,31 @@
+//
+//  PPColombiaIDFrontRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 30/01/2018.
+//
+
+#import "PPDetectorRecognizerResult.h"
+
+/**
+ * Class representing values obtained when scanning front side of Colombian ID
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPColombiaIDFrontRecognizerResult : PPDetectorRecognizerResult
+
+/**
+ * The first name of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *firstName;
+
+/**
+ * The last name of the Colombian ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *lastName;
+
+/**
+ * The document number of the Colombian ID card.
+ */
+@property (nonatomic, readonly, nullable) NSString *documentNumber;
+
+@end

MicroBlink.framework/Headers/PPColombiaIDFrontRecognizerSettings.h

@@ -0,0 +1,85 @@
+//
+//  PPColombiaIDFrontRecognizerSettings.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 30/01/2018.
+//
+
+#import "PPRecognizerSettings.h"
+
+/**
+ * Settings class for configuring Colombian Front ID Recognizer.
+ *
+ * Colombian Front ID recognizer is used for scanning front side of Colombian ID.
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPColombiaIDFrontRecognizerSettings : 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 first name should be extracted from Colombian ID
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractFirstName;
+
+/**
+ * Defines if owner's last name should be extracted from Colombian ID
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractLastName;
+
+/**
+ * Sets whether face photo 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) BOOL displayFacePhoto;
+
+/**
+ * Sets whether signature photo 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) BOOL displaySignaturePhoto;
+
+/**
+ * Sets whether full 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) BOOL displayFullDocumentImage;
+
+/**
+ * Defines if glare detection should be turned on/off for front side of Colombian IDs.
+ *
+ * Default: YES
+ */
+ @property (nonatomic, assign) BOOL detectGlare;
+
+@end
+

MicroBlink.framework/Headers/PPEudlRecognizerSettings.h

@@ -91,6 +91,7 @@ PP_CLASS_AVAILABLE_IOS(6.0)
 
 /**
  * Property got setting DPI for full document images
+ * Valid ranges are [100,400]. Setting DPI out of valid ranges throws an exception
  *
  * Default: 250.0
  */

MicroBlink.framework/Headers/PPGermanPassportRecognizerResult.h

@@ -6,13 +6,13 @@
 //  Copyright © 2016 MicroBlink Ltd. All rights reserved.
 //
 
-#import "PPDetectorRecognizerResult.h"
+#import "PPMrtdRecognizerResult.h"
 
 /**
  * Class representing values obtained when scanning front side of German ID
  */
 PP_CLASS_AVAILABLE_IOS(6.0)
-@interface PPGermanPassportRecognizerResult : PPDetectorRecognizerResult
+@interface PPGermanPassportRecognizerResult : PPMrtdRecognizerResult
 
 /**
  * The surname of the German Passport owner.

MicroBlink.framework/Headers/PPHongKongIDFrontRecognizerResult.h

@@ -0,0 +1,46 @@
+//
+//  PPHongKongIDFrontRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 05/02/2018.
+//
+
+#import "PPDetectorRecognizerResult.h"
+
+/**
+ * Class representing values obtained when scanning front side of Hong Kong ID
+ */
+PP_CLASS_AVAILABLE_IOS(6.0)
+@interface PPHongKongIDFrontRecognizerResult : PPDetectorRecognizerResult
+
+/**
+ * The full name of the Hong Kong ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *fullName;
+
+/**
+ * The commerical Code of the Hong Kong ID.
+ */
+@property (nonatomic, readonly, nullable) NSString *commercialCode;
+
+/**
+ * The date of birth of the Hong Kong ID ownder.
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfBirth;
+
+/**
+ * The sex of the Hong Kong ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *sex;
+
+/**
+ * The issue date of the Hong Kong ID owner.
+ */
+@property (nonatomic, readonly, nullable) NSDate *issueDate;
+
+/**
+ * The document number of the Hong Kong card.
+ */
+@property (nonatomic, readonly, nullable) NSString *documentNumber;
+
+@end