Changelog

5.7.0

July 13, 2022

• Add Support for V2 License Keys

• Ensure MRZ Information Key is decoded and surfaced properly on MRZ Scan

• Embed Passport IC Data into Image XMP

• Allow full MRZ to be read from ID1 Documents

5.6.0

March 8, 2022

• The SDK now requires iOS 13+

• Dynamic Capture Feedback has been added to enhance Auto Capture (see Capture Modes for more details)

• New, optional light-base quality checks have been added (Document Lighting, Glare, Contrast)

  • Currently exclusive to Dynamic Capture Feedback

• The SDK can now build and run on M1 iOS Simulators

• The method of non-flash image capture during Auto Capture can now be configured via DSOptions.autoCaptureImageSource (default: .videoFrameGrab)

  • .stillPhotoCapture: Captures an image using a still-photo capture from the device camera (slower, higher-quality)

  • .videoFrameGrab: Captures an image using a frame from the streaming video session (faster, lower-quality)

• The default DSOptions.autoCaptureTimeoutDuration has been increased to 30 seconds

5.5.3

October 13, 2021

• Calculation of CaptureAnalysis.distanceConfidence has been improved:

  • Distance Confidence is now measured accurately and consistently across all devices

  • Captures that are “too close” will no longer have a Distance Confidence of 0 unless the document cannot be captured by the camera

• Fixes an Xcode 13 warning produced when importing the SDK

5.5.2

October 4, 2021

• Fixed an issue that prevented face detection in documents on iOS 15

5.5.1

September 17, 2021

• Fixed a bug during the crop process where it would not crop all the way to the document edges, and sometimes distort the image.

5.5.0

September 7, 2021

• Auto Capture feature added

• Fixed barcode decoding bug for state ID’s

• Made the capture cutout calculations more robust

5.4.0

July 1, 2021

• Reduced size of SDK

• Fixed barcode decoding crash for 2005 style NY Driver’s License

• Removed the need for the margin pegs in the capture overlay

5.3.2

March 12, 2021

• Added the maximumDPI prooperty in DSOptions. It can vary from 600 to 900

5.3.1

January 20, 2020

• The SDK is now distributed as an XCFramework instead of a fat framework

• The SDK will now compile and run on any iOS Simulator

5.3.0

November 19, 2020

• Integrated On Device Segmentor, which will now crop and rectify the document images on device. As a result Client application can choose to submit Cropped or Uncropped images. This works for both Passport (ID3) and Driver License (ID1) documents.

• Enhanced confidence score to be a marker for when to retake an image. This property’s value ranges between 0 and 1. A higher score indicates better quality.

• Added additional properties to return cropped images.

• The DSResult.image and DSResult.flashImage property will now dynamically hold a cropped or uncropped image. Two properties, isImageCropped and isFlashImageCropped now indicate the type of image in the property.

• Barcode detection will now use both cropped and uncropped images when checking for the barcode.

• Added a distance confidence score to ensure the image can’t be captured from too far off.

• Moved the focus score to the newly created captureAnalysis property on DSResult.

• Change in EXIF timestamp date format.

5.2.0

October 7, 2020

• The document capture overlay has visual guides to indicate the space required around the edges of the document.

• When setting compressionQuality via CFADocumentSettings, the SDK was max- ing out any number greater than 0. The property now respects values between 0 and 100.

• To handle the new, denser barcodes, targetDPI will now max out at 1000

• Auto DPI scaling if barcode is not detected on back side scans

• SDK will now be able to compile with Xcode 12.x

• SDK is now independent of the version of Swift that you are using (5.1 and above)

• Document capture image processing has been optimized to work with A8 processors

• New class-level license key api added: CFDocumentScan.licenseExpirationDate()

• Added capability to modify UI elements with the SDK. Modify the UIConfigurations.json file to change colors, font sizes, etc.

5.1.1

June 17, 2020

• Added the support for decoding the 2D Barcode on British Columbia DLs.

• Added support for UI Configurations. The integrating application can now customize the UI elements (text, font and color).

• Added Accessibility support.

• Added Support for RTL language support which will get triggered as per the localization settings.

• New method is introduced to set License Key, and the existing method has been deprecated.

5.1.0

May 20, 2020

• The algorithm to pick the best quality image once the user clicks for capture has been enhanced.

• Barcode and MRZ Detection are now made optional. Currently MRZ data is returned as dashed strings. In the future releases these will be the actual MRZ Strings extracted from the documents.

• Improved UI for DL and passport capture screens to enable to user for placing the document within the capture area.

• The name of the SDK is changed to CFADocumentCapture. New function is introduced in the DSHandler API, which enables app to add SDK Controller to App UIController.

5.0.0

April 28, 2020

• New API has been introduced called DSHandler.

• New UI has been introduced along with the new API.

• Removed support to Microblink and Anyline libraries and MRZ and barcode extraction capabilities are done using native.

4.1.3

December 20, 2019

• The Microblink framework is updated to 5.0.2

4.1.2

December 12, 2019

• Fixed the date issue for DOB and Issue date when the Japanese calendar is selected from settings.

• Added support for iPhone 11 series devices.

4.1.1

November 8, 2019

• Issue with locale having “-” such as zh-Hant, may lead to application crash upon SDK installation in iOS 13 and above, is fixed.

• Issue with returning an inverted image when the cropper points aligned cross ways manually on the cropper screen, is fixed. This is fixed in the 4.0.4 release and also been patched for 4.1.0.

• MRZ extraction with Microblink was working only when isHKIDDocument is set to true, which need not to be set for passports. This is now fixed.

4.1.0

July 25, 2019

Enhancements

• Providing support for RTL devices and for Accessibility devices.

• Introduced “swapDialogActions” setting, which allows client to swap the buttons on the alert dialog, and the default value is false.

• New setting “exitAfterTimeOut” is introduced, which allows users to exit the SDK after timeout is triggered with the error callback. Document Error Code: 2017 and Selfie Error Code: 4011 (near Selfie) and 4058 (far Selfie).

• We made “AlertDialog” on cancelling the scan as optional with the help of new setting called “enableCancelDialog”. This new setting design is made configurable and the default value set to True.

• New callback has been added for MRZ extracted data, which returns Dictionary instead of Strings. Older callback is deprecated and works as usual and may be removed in the further releases.

• Added MRZ detection using Microblink, in the absence of Anyline, CatfishAIR will invoke Microblink for MRZ detection on passports.

• Progress dialog in SDK is now made configurable and gif can be replaced by client, if necessary.

• Added camera, photos, and location permission access from app side to enable camera, photos, and location.

• Background of scan area is now made configurable. Bitcode is supported in document SDK.

• Dsym is supported in Document SDK. Microblink framework is updated to 4.9.0. MRZWrapper framework (Anyline) is updated to 9.

Fixes

• Added HairColor, OrganDonor, LicenseClass for 2D-barcode extracted data.

• Fixed the UI related issues taking place upon selecting the Arabic language from localization.

• The app crashing issue while accessing the Camera Permission in the Simulator is fixed.

• Fixed the capturing issue for Green ID documents not being supported in Auto mode for iPAD PRO 11 due to Aspect Ratio.

• Fixed the issue of returning black image when the user double clicks the Accept Icon in Cropper Screen for the Captured ID1 Back Document [Original Cropped Image = docData].

• SDK crashes, if repeatedly permissions are changed from the SDK Settings to Device app Settings or vice versa. This issue is fixed.

• Issue with Camera and Photo permission pop-ups while reinstalling the App due to OS behavior is resolved.

4.0.4

October 1, 2019

• Issue with returning an inverted image when the cropper points aligned cross ways manually on the cropper screen, is fixed.

4.0.3

June 7, 2019

• A setting to generate the dsym file is added, which symbolicates a crash report to find where the crash has occurred in the source code.

4.0.2

May 8, 2019

• DocumentCapture SDK is updated with Microblink 4.9.0

4.0.1

January 7, 2019

• Custom fonts are supported in the Document Capture SDK and Selfie Capture SDK.

• Line spacing for the texts displayed in the Instruction Overlay is reduced in the Document Capture SDK.

• Spacing between the label “Center the bubble” and bubbleView is increased in the Document Capture SDK.

• The text “Face captured, Processing” appears once the near selfie is captured in the Selfie Capture SDK.

• All the texts which has background such as indicators, Got it, live overlays are vertically aligned in the Document Capture SDK and Selfie Capture SDK.

4.0.0

December 10, 2018

• Direct API is introduced in the SDK in addition to the existing Camera APIs, to increase the flexibility of end user for designing and controlling their own user interface for their Mobile APPS without restricting to use or configure our SDK UI elements and at the same time retain the core SDK image processing features.

• All the class names in the SDK are added with a prefix “CFA” to resolve name conflicts with other third-party SDKs or app integrating the SDK.

• New HKID algorithm is integrated in order to support few cards where the first two characters of the Document number are alphabets.

• For Passport landscape captures, SDK now supports rectification on device when enable Rectification setting is set as true. This returns a cropped passport document similar to ID1 and ID2. If Flash is enabled, it returns a flash cropped passport document also.

• Client application can now change the border width/color on the overlay screens.

• Manual timeout is made optional and it is turned off by setting its value to 0. CaptureMode will never go to manual if both “timeoutinsec” and “initialtimeoutinsec” are set to 0.

• New error codes are added. Please refer to the API documentation for more information.

• Anyline SDK has been updated to v3.27.2 in iOS as a fix for a bug where Anyline was crashing on new iPhone generation (Sep. 2018) devices.