Skip to content

MobileID SDK - Release Notes

9.2.8

Provider updates

  • Updated the recommended AMADocRFIDReadiOS provider version to 2.0.11. It works with SDK 9.2.8; no SDK update is needed.
  • AMADocRFIDReadiOS 2.0.9 reads the chip faster, so slow chips such as Dutch passports finish before the chip reading timeout.
  • AMADocRFIDReadiOS 2.0.10 fills the rfid section (check digits, optional data and MRZ type) from the chip MRZ (DG1), and no validations field is nil after a chip read any more: a check the chip cannot answer is unknown.
  • AMADocRFIDReadiOS 2.0.11 takes the surname and given names from the chip MRZ (DG1), so passports that store the name in national characters in DG11, such as Chinese passports, return it in Latin characters.

Improvements

  • initWith verifies the licence with the APIConfig.publicKey you pass, so an environment with its own key pair is accepted. When no publicKey is passed, or the value is not a key, the SDK uses its built-in key, as before. initOffline is unchanged.
  • Pass publicKey as the bare base64 SubjectPublicKeyInfo body, without the -----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY----- lines; a PEM key is ignored for header encryption.
  • Updated VBImageProcessor to 1.2.5.

9.2.7

Improvements

  • Updated VBImageProcessor to 1.2.4, a rebuild of 1.2.2 with VBUtils 2.0.3; no functional changes.

9.2.6

Improvements

  • Updated the recommended DocScanMrz provider version to 2.0.8.
  • DocScanMrz 2.0.8 crops the image sent to the MRZ engine around the on-screen frame, so passports are read on the smallest iPhones and at large text sizes.

Bug Fixes

  • A document read calls the completion handler exactly once, whichever of the scan and chip timeouts fires first. A scan result that arrives after a timeout is ignored and no longer opens the chip reading screen.
  • When the DocScanMrz provider's own scan timeout expires, the SDK now returns MrzTimeout (152) instead of Unknown (180).
  • DocScanMrz 2.0.8 no longer reports a parsing failure before the MRZ has been fully read.
  • DocScanMrz 2.0.8 keeps the scan running while the help sheet is shown.

9.2.5

Improvements

  • Boarding pass validation accepts BCBP version numbers 1 to 9 (previously 6 and 7).
  • Updated the recommended DocScanMrz provider version to 2.0.7.

Bug Fixes

  • Boarding passes that repeat the conditional data block, such as Jetstar boarding passes, no longer fail with BoardingPassItemParserError (251).
  • A truncated boarding pass barcode no longer crashes the SDK.
  • Face capture follows a container or sheet that resizes after presentation; the preview, the oval and the captured photo adapt to the new size.
  • Portrait-only screens return to portrait orientation on iOS 15.
  • The boarding pass scan viewfinder redraws when the screen is resized.
  • DocScanMrz 2.0.7 keeps the MRZ hint on one line at every text size.

9.2.4

Improvements

  • Removed the Matomo analytics dependency; the SDK no longer links MatomoTracker. A Matomo log strategy in the server configuration is now ignored.
  • Updated VBUtils to 2.0.3 and VBImageProcessor to 1.2.3.
  • Updated the recommended DocScanMrz provider version to 2.0.6.
  • Updated the recommended DocRFID provider version to 2.0.8, which requires AMADocModeliOS 2.0.3.

Bug Fixes

  • DocScanMrz 2.0.6 dismisses the scanner before delivering the result.
  • DocScanMrz 2.0.6 returns the correct best-frame document image.

9.2.3

Improvements

  • Updated the recommended DocScanMrz provider version to 2.0.5.
  • Updated the recommended AMAShareUltralight provider version to 2.0.17.
  • AMAShareUltralight 2.0.17 uses UltralightFramework 3.3.4.
  • AMAShareUltralight 2.0.17 supports arm64 iOS devices and arm64 plus x86_64 iOS Simulators.
  • The Swift package uses automatic linkage; consumers must still resolve and package the provider's required binary dependencies.

Bug Fixes

  • Improved DocScanMrz scanner cleanup and re-initialization behavior.
  • Replaced run-loop-dependent MRZ processing timeouts with cancellable timeouts.
  • Corrected VIZ document-type mapping with a forward-compatible unknown-value fallback.

9.2.1

Improvements

  • Updated the recommended provider version for AMAShareUltralight to 2.0.13.

Bug Fixes

  • Improved callback user experience during RFID processing.

9.2.0

What's new

  • General bug fixes.
  • Function func share(passengers: [AMADocModeliOS.Passenger]) async -> (result: Bool?, error: FeatureError?) is now func share(passengers: [AMADocModeliOS.Passenger], completionHandler: @escaping (Bool, FeatureError?) -> Void)

Improvements

  • Updated the recommended provider versions: DocScanMrz 2.0.3, Doc RFID Read 2.0.2, and Ultralight 2.0.4.

9.1.0

What's new

  • Added support for the new RFID reader provider.
  • Removed DocumentData from the Document Reader feature. Use the IdDocument from the DocumentReaderReport, which contains the same data as DocumentData.
  • Added the Name Match feature, allowing a names comparison between a candidate and a reference using Enrolment.shared.matchNames(reference:compare:strategy:). See Name Match section.

9.0.0

What's new

8.1.7

Improvements

  • Fixed issue when starting the database update in the background with the startUpdateDatabase function.

8.1.6

Improvements

  • BoardingPassSummary and BoardingPassFull now fully support the Codable and Equatable protocols, improving data serialization and comparison.
  • Fixed an issue in parseBoardingPass function when passing an image without a QR code on the ParseBoardingPassParameters

8.1.5

Improvements

  • SubjectStatus and Subject are now compliant with the codable protocol

8.1.4

Improvements

  • Adding new parameters to BiometricFaceCaptureParameters that allow controlling animation times.

8.1.3

Improvements

  • Improved animation time in the Biometric Face Capture Feature

8.1.2

Improvements

  • Removed dependency on external JWTDecoder library
  • Enhanced UI layout consistency - by improving ui margins
  • Fixed issue on square biometric face capture callback being triggered multiple times

8.1.0

What's new

  • Added a new property to matchReport that indicates the score of the biometric match in success cases as well.
  • New IdDocument class that will replace DocumentData in the document reader report.
  • Added offline mode support.
  • New license mechanism via jwt token.

Improvements

  • Improved custom loading screen in subject feature
  • Improved internal logging capabilities.

Warning

  • The object DocumentData from the Document Reader feature is deprecated and will be removed in the future, please update to the new object IdDocument.

8.0.0

What's new

  • New, streamlined Face Capture UI.

Improvements

  • Reduced initialization time for document reader.
  • Mirror photo when using the front camera.
  • Removed unnecessary screens for a cleaner user experience. Check sample in github for examples with the error and preview screens.

Technical Enhancements

  • Centralized configuration management.
  • Modularized the SDK for better maintainability and scalability.
  • Bugs fixes.

Warning

  • The square option from BiometricFaceCaptureFrameOptions is deprecated and will be removed in the future, please use the oval option.

7.3.4

Improvements

  • BiometricFaceCapture: reduced the time required to open the camera, improving user experience.
  • Timezone Handling: Corrected a problem with how the application handles timezone data.

7.3.3

Improvements

  • Updated Regula SDK to version 7.5.

7.3.2

Improvements

  • Fix issues with Camera permissions.
  • Updated Lottie SDK to version 4.4.1.
  • Fix face capture animation bug, where the face selection frame was moved to top left corner.

7.3.1

Improvements

  • Updated VBDependencyInjector SDK to version 1.0.5.

7.3.0

Improvements

  • Add choice of the scenarios for the document capture
  • Remove Sentry has an external dependency

7.2.2

Improvements

  • Updated Sentry SDK to version 8.33.

7.2.1

Improvements

  • Updated Regula SDK to version 7.4.
  • Support to SPM

7.2.0

Improvements

  • Face Capture Timeout: Introduced a configurable timeout for the Face Capture feature. This can be set using the faceCaptureTimeout parameter in BiometricFaceCaptureParameters. The timeout default is disabled and the minimum allowed timeout is 30 seconds.
  • Improved localization support documentation
  • Error Handling: Removed the retry button from the default error screen for InternalError cases as retries are not effective in these situations.
  • Updated Regula SDK to version 7.3.
  • Changed the ScanTimeout error type to Timeout.
  • Fixed an infinite loop issue in the Document Reader.
  • Resolved layout inconsistencies in the Face Capture UI.
  • Prevented simultaneous pressing of RFID skip and start buttons in the Document Reader.

7.1.2

Improvements

  • Update Regula to 7.2
  • Improvements in BiometricFaceCapture feature.

7.1.1

Improvements

  • Added a new parameter to ReadDocumentParameters called showRFIDInstructions that allows you to skip the RFID scan instruction screen

7.1.0

Improvements

  • Improved security measures:
    • Communications with the backend are now encrypted using hybrid encryption;
    • Data integrity is verified in communications with the backend;
    • Data integrity is verified in the build subject and face match operations;
    • HTTP responses are signed and verifiable

What's new

  • Form feature

7.0.1

Improvements

  • Fixed an issue with Boarding Pass Preview clickable rows
  • Added a new parameter to DocumentReaderConfig called checkHologram* to enable Regula's hologram scan, to prevent fraudulent documents.
  • Removed mandatory preview screen in face capture;
  • Changed adding a subject without a boarding pass when it's mandatory error code to it's own error code;
  • Fix id 215 and 224 to appear as IDCard in Document Reader
  • Fix issues with oval drawing in Face Capture

7.0.0

What's new

  • New subject service (now works asynchronously)
  • Removed the get, delete and update subject signatures;
  • Clients need to save the subject locally after adding.
  • Improve error handling
  • The boarding pass can be read from an image

Improvements

  • Fix issues with Loading Screen Animations
  • Add Camera permissions messages in Boarding Pass Scanner and Face Capture

5.2.3

Improvements

  • Updated to Lottie 4.3.3

5.2.2

Improvements

  • Improved the fetching of needed resources in the DocumentReader feature.

5.2.1

Improvements

  • Improved Face capture process by:
  • Improved multiple faces check to focus on the closer face.
  • Added CameraConfig to BiometricFaceCaptureParameters to control if the toggle camera button should appear and the initial camera facing (Front or back camera)

5.2.0

Improvements

  • The frameShape field of the class BiometricFaceCaptureParameters can now be set to choose between an oval or square shape, default is oval
  • The scannerTimeout and rfidTimeout field of the class ReadDocumentParameters has a maximum and minimum value (maximum 60, minimum 10)
  • The scannerTimeout field of the class ReadDocumentParameters can now be set to nil to be disabled
  • Removed preview custom views from every feature, if you don't want our default screen, turn off the showPreview flag in feature parameters.
  • Removed error custom views from every feature, if you don't want our default screen, turn off the showErrors flag in feature parameters.
  • Refactor remaining custom views protocols to make it easier to implement.
  • Added feature to disable regula passive auth for some documents by their ID.
  • Improved loading animations.
  • Improved image handling process.
  • Updated Regula version to 6.8

5.1.1

Improvements

  • Updated to Lottie 3.4;

5.1.0

Improvements

  • Minor UI/UX improvements.
  • Added TemplateOption to BiometricMatchParameters

Removed

  • Liveness icon from Face Capture preview screen

5.0.3

Improvements

  • Improved RFID timeout, now only starts after instruction screen.
  • Improved error and timeout messages. 
  • Improved UI
  • Added animations to improve UX.

5.0.2

Improvements

  • Updated to Regula 6.6;

5.0.1

What's new

  • Biometric Face Capture now has real-time image processing with more feedback to increase odds of taking a quality picture for the match service;
  • The EnrolmentConfig has a new configuration to set the SDK language;
  • Document Reader database download can now be controlled by the client;
  • Added logs to Subject Builder;

Improvements

  • Upgraded external dependencies;
  • Migrated to Vision framework for image processing;
  • Improved Sentry logs;
  • Improved feature logs;
  • Improved SDK default UI;
  • Simplified SDK configurations by moving some to backoffice;
  • New Biometric Match service that improved performance;
  • Uses Mobile API 4.0;
  • Updated to Regula 6.3;

Removed

  • Alamofire library;
  • Localization support from backend;