Releases: doo/scanbot-sdk-ios-spm
Releases · doo/scanbot-sdk-ios-spm
7.1.3-RC1
- 🎉 New:
- Check:
- We now extract the field after the account number on US checks. The name in the result is
checkNumber
. Note that this name is only based on common usage and not on any enforced standard.
- We now extract the field after the account number on US checks. The name in the result is
- Check:
- 🚀 Improvements:
- Check:
- Updated US check field documentation.
- Check:
- 🐞 Bug fixes:
- Check:
- Fixed a bug in the implementation of the US check standard which lead to rejection of valid checks.
- Fixed a bug in Check Scanner RTU-UIv2 that delivered (invalid) results when
documentDetectionMode
was set to =detectAndCropDocument
.
- Check:
7.1.2
- 🎉 New:
- General:
- Added property
isInterrupted
toSBSDKCameraSession
to indicate if the camera session was interrupted by the system.
- Added property
- Document Scanner:
- Added property
documentPreviewImageSizeLimit
inSBSDKDocumentPage
to limit the size of the document preview image.
- Added property
- General:
- 🚀 Improvements:
- Document Scanner:
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
speed
now is significantly faster, the modebalanced
is a bit faster and the modequality
is a bit slower with the best possible image quality.
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
- Document Scanner:
- 🐞 Bug fixes:
- Document Scanner:
- Fixed an issue on simulators where the shutter button was missing in the RTU-UI document scanner.
- Document Data Extractor:
- Fixed a bug where the
incompleteValidation
status was incorrectly returned in the document data extractor (RTU-UI v2).
- Fixed a bug where the
- Check Scanner:
- Fixed a bug where the "no check" dialog was displayed when camera permission was denied in the check scanner (RTU-UI v2).
- General:
- Fixes a bug with scanned documents cloning when using per-file encryption.
- Document Scanner:
7.1.1-RC3
- 🎉 New:
- General:
- Added property
isInterrupted
toSBSDKCameraSession
to indicate if the camera session was interrupted by the system.
- Added property
- Document Scanner:
- Added property
documentPreviewImageSizeLimit
inSBSDKDocumentPage
to limit the size of the document preview image.
- Added property
- General:
- 🚀 Improvements:
- Document Scanner:
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
speed
now is significantly faster, the modebalanced
is a bit faster and the modequality
is a bit slower with the best possible image quality.
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
- Document Scanner:
- 🐞 Bug fixes:
- Document Scanner:
- Fixed an issue on simulators where the shutter button was missing in the RTU-UI document scanner.
- Document Data Extractor:
- Fixed a bug where the
incompleteValidation
status was incorrectly returned in the document data extractor (RTU-UI v2).
- Fixed a bug where the
- Check Scanner:
- Fixed a bug where the "no check" dialog was displayed when camera permission was denied in the check scanner (RTU-UI v2).
- General:
- Fixes a bug with scanned documents cloning when using per-file encryption.
- Document Scanner:
7.1.1-RC2
- 🎉 New:
- General:
- Added property
isInterrupted
toSBSDKCameraSession
to indicate if the camera session was interrupted by the system.
- Added property
- Document Scanner:
- Added property
documentPreviewImageSizeLimit
inSBSDKDocumentPage
to limit the size of the document preview image.
- Added property
- General:
- 🚀 Improvements:
- Document Scanner:
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
speed
now is significantly faster, the modebalanced
is a bit faster and the modequality
is a bit slower with the best possible image quality.
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
- Document Scanner:
- 🐞 Bug fixes:
- Document Scanner:
- Fixed an issue on simulators where the shutter button was missing in the RTU-UI document scanner.
- Document Data Extractor:
- Fixed a bug where the
incompleteValidation
status was incorrectly returned in the document data extractor (RTU-UI v2).
- Fixed a bug where the
- Check Scanner:
- Fixed a bug where the "no check" dialog was displayed when camera permission was denied in the check scanner (RTU-UI v2).
- General:
- Fixes a bug with scanned documents cloning when using per-file encryption.
- Document Scanner:
7.1.1-RC1
- 🎉 New:
- General:
- Added property
isInterrupted
toSBSDKCameraSession
to indicate if the camera session was interrupted by the system.
- Added property
- Document Scanner:
- Added property
documentPreviewImageSizeLimit
inSBSDKDocumentPage
to limit the size of the document preview image.
- Added property
- General:
- 🚀 Improvements:
- Document Scanner:
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
speed
now is significantly faster, the modebalanced
is a bit faster and the modequality
is a bit slower with the best possible image quality.
- Rebalanced the internally used photo capture settings to better match the photo quality priorization modes. The mode
- Document Scanner:
- 🐞 Bug fixes:
- Document Scanner:
- Fixed an issue on simulators where the shutter button was missing in the RTU-UI document scanner.
- Document Data Extractor:
- Fixed a bug where the
incompleteValidation
status was incorrectly returned in the document data extractor (RTU-UI v2).
- Fixed a bug where the
- General:
- Fixes a bug with scanned documents cloning when using per-file encryption.
- Document Scanner:
7.0.6-Beta3
WARNING: Release Notes for version 7.0.6 not found!
7.0.6-Beta2
WARNING: Release Notes for version 7.0.6 not found!
7.0.6-Beta1
WARNING: Release Notes for version 7.0.6 not found!
7.1.0-RC10
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabled
toSBSDKUI2CameraConfiguration
. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimit
toSBSDKUI2CameraConfiguration
andSBSDKUI2DocumentScannerCameraConfiguration
to limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandler
toSBSDKZoomingImageScrollView
. - Added analytics support with new classes:
SBSDKAnalyticsManager
,SBSDKAnalyticsEvent
,SBSDKAnalyticsFeature
,SBSDKAnalyticsCategory
,SBSDKAnalyticsEventName
,SBSDKAnalyticsEventFactory
, andSBSDKAnalyticsSubscriber
for tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelection
for managing collections of selected barcode items. - Added property
identityString
toSBSDKBarcodeItem
to uniquely identify barcodes across detection frames. - Added property
selectedZoomFactor
toSBSDKUI2BarcodeScannerUIResult
to retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItem
has a new fieldrawBytesEncodings
that contains the precise character encoding information ofrawBytes
.SBSDKBarcodeItem
has a new fieldstructuredAppendInfo
. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItem
has a new fieldglobalIndex
which allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfiguration
has a new fieldaccumulationConfig
which allows the accumulation of barcodes over multiple frames in live mode.
- Added new class
- Check Scanner:
- Introduced a new Check RTU-UI v2 component, see
SBSDKUI2CheckScannerViewController
. - Introduced a boolean
captureHighResolutionImage
in Check Scanner Classic UI. If disabled, the scanning is performed on video frames. When enabled, a high-resolution photo is captured and used for scanning, which may result in slower scanning speed.
- Introduced a new Check RTU-UI v2 component, see
- Document Data Extractor:
- Introduced a new Data Extractor RTU-UI v2 component, see
SBSDKUI2DataExtractorViewController
. - Added support for the front side of many more drivers license models.
- Added (partial) support for parsing of German addresses. For the respective ID cards, address parsing can be enabled via a new
SBSDKDeAddressParserConfiguration
. If the parsing was successful, the parsed address is stored as a child document (similar to MRZ). - Added support for multiple new document types:
- ID Cards from Brazil, Hong Kong, Macao, China
- Chinese Entry & Exit Permits
- The Document Data Extractor now detects whether a document is in focus already and only starts the heavy recognition pipeline when the image quality is suitable.
- Added a new method
setGlareDetectionConfiguration
method inSBSDKDocumentDataExtractorConfigurationBuilder
to fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfig
inSBSDKDocumentDataExtractorConfigurationBuilder
to precisely control the exclusion of frames that lack focus. - The Document Data Extractor can now detect glare in images. If fields are obstructed by glare, these fields will be returned with a validation status of
SBSDKGenericDocumentFieldValidationStatus.obstructed
. - Added case
errorStillFocussing
toSBSDKDocumentDataExtractionStatus
. - Returns the issuing series of German ID Cards as part of the returned document as the
Series
field. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStart
toSBSDKUI2DocumentScanningFlow
. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScan
toSBSDKUI2CameraScreenConfiguration
. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAdding
toSBSDKUI2ReviewScreenConfiguration
. If enabled the review screen will be opened showing the last page.
- Added property
- MRZ Scanner:
- Added support for non-ICAO conformant machine readable zones on US border crossing cards.
- Vehicle Identification Number Scanner:
- Introduced a new VIN RTU-UI v2 component, see
SBSDKUI2VINScannerViewController
.
- Introduced a new VIN RTU-UI v2 component, see
- General:
- 🚀 Improvements:
- Barcode Scanner:
- Added NSCopying support to
SBSDKBarcodeTrackedViewPolygonStyle
andSBSDKBarcodeTrackedViewTextStyle
. SBSDKBoardingPassBarcodeDocumentParser
now supports up to version 8 of the IATA-BCBP standard.- vCard document parser was improved.
- Added NSCopying support to
- Check Scanner:
- If image cropping is enabled and is successful, check recognition is performed on the crop instead of the original image.
- Credit Card Scanner:
- Added support for credit cards with an expiry date above the card number.
- Added support for credit cards with a name written in two lines.
- Document Data Extractor:
- General speed improvements.
- Now detects whether a document is in focus already and only starts the heavy recognition pipeline when the image quality is suitable.
- Classification for documents with MRZ is more stable.
- Added normalization before date recognition.
- More consistent usage of common field types.
- Improved maiden name processing for DePassport and DeIdCard.
- Now also supports the new German ID card format issued starting 2024.
- Document Quality Analyzer:
- Improved performance. Note: document quality scores may slightly change for the same input images when compared to the previous version of the DoQA.
- Document Scanner:
- Improved landscape-orientation layout of RTU-UIv2 screens.
- Increased performance for Document Scanner algorithms.
- The zoomed page view in the RTU-UIv2 review screen now closes when you finish zooming while being below the minimum zoom value.
- Medical Certificate Scanner:
- Date recognition in Medical Certificate forms is now based on the Scanbot OCR Engine and shows significant quality improvements.
- MRZ Scanner:
- On US border crossing permits, the document number is now returned in the correct field.
- Dates in MRZ now also support
parsedData
correctly.
- Scanbot OCR Engine:
- Improved performance of the Scanbot OCR engine.
- Text Pattern Scanner:
- General speed improvements.
- Now supports XNNPACK for faster inference.
- Barcode Scanner:
- 🐞 Bug fixes:
- General:
- Fixed some rare crashes in Credit Card Scanner, Document Data Extractor and MRZ Scanner.
- PDF Generation:
- Fixes a bug where PDFs with embedded OCR were invalid.
- Barcode Scanner:
- The carrier identifier for MaxiCode mode 3 might be encoded by using different codewords. Now all possible codewords are checked that encode the carrier identifier.
- vCard document parser now correctly processes the "FN" key as FormattedName.
- Fixed a bug in the Barcode Scanner RTU-UI v2 where the result callback was called multiple times.
- Credit Card Scanner:
- Fixed a crash if document detection was not successful due to an
OK_BAD_ASPECT_RATIO
status. - Setting the confirmation method to
interpolate
when scanning credit cards could result in unsuccessful recognitions although all data was extracted and verified. - Return correct scanning status if no fields are recognized.
- Fixed a crash if document detection was not successful due to an
- Document Data Extractor (DDE):
- When
IssuerNumber
is excluded on European health insurance cards, this no longer leads to theIssuerName
being incorrectly excluded. - MRZ fallback now also works when no accepted document types are selected.
- When
- Document Quality Analyzer:
- Fixed quality estimation for rotated images.
- Document Scanner:
- Fixed a bug in RTU-UI V2 Document Scanner where the document could not be captured in auto snap mode, when
enabledInAutoSnappingMode
is set to false inSBSDKUI2ShutterButton
. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerView
where the completion handler is not called when the view is a root view. Additionally, the view is now prevented from being automatically dismissed upon completion. - Fixed a bug in RTU-UI V2 Document Scanner where auto rotation was applied if no document was detected.
- Fixed a bug in RTU-UI V2 Document Scanner where the document could not be captured in auto snap mode, when
- Image Editing:
- Fixed a rare crash when the screen orientation changes.
- MRZ Scanner:
- Fixed an issue causing
nil
to be returned as a confidence of empty fields.
- Fixed an issue causing
- PDF Image Extractor:
- Fixes wrong orientation of extracted images when the PDF page has a transform applied.
- Storage Crypting:
- Fixed data corruption issues in AES encryption/decryption that could result in corrupted or partially corrupted files.
- General:
⚠️ Breaking changes:- General:
- Replaced all occurrences of the deprecated
AVCaptureVideoOrientation
enum by an equal enum namedSBSDKVideoOrientation
.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectable
andisAutomaticSelectionEnabled
fromSBSDKBarcodeTrackingOverlayConfiguration
. - Renamed parameter
isSelected
toisHighlighted
in tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate
:- Removed
didChangeSelectedBarcodes
method. - Added
shouldHighlight
method to determine barcode highlighting state. - Added
proposedStyle
parameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerState
toSBSDKCheckScannerState
.
�- Renamed the enum caserecognizing
toscanning
inSBSDKCheckScannerState
. - Removed
acceptedCheckTypes
fromSBSDKCheckScanner
and `SBSDKCheckScannerViewControl...
- Renamed enum
- General:
7.1.0
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabled
toSBSDKUI2CameraConfiguration
. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimit
toSBSDKUI2CameraConfiguration
andSBSDKUI2DocumentScannerCameraConfiguration
to limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandler
toSBSDKZoomingImageScrollView
. - Added analytics support with new classes:
SBSDKAnalyticsManager
,SBSDKAnalyticsEvent
,SBSDKAnalyticsFeature
,SBSDKAnalyticsCategory
,SBSDKAnalyticsEventName
,SBSDKAnalyticsEventFactory
, andSBSDKAnalyticsSubscriber
for tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelection
for managing collections of selected barcode items. - Added property
identityString
toSBSDKBarcodeItem
to uniquely identify barcodes across detection frames. - Added property
selectedZoomFactor
toSBSDKUI2BarcodeScannerUIResult
to retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItem
has a new fieldrawBytesEncodings
that contains the precise character encoding information ofrawBytes
.SBSDKBarcodeItem
has a new fieldstructuredAppendInfo
. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItem
has a new fieldglobalIndex
which allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfiguration
has a new fieldaccumulationConfig
which allows the accumulation of barcodes over multiple frames in live mode.
- Added new class
- Check Scanner:
- Introduced a new Check RTU-UI v2 component, see
SBSDKUI2CheckScannerViewController
. - Introduced a boolean
captureHighResolutionImage
in Check Scanner Classic UI. If disabled, the scanning is performed on video frames. When enabled, a high-resolution photo is captured and used for scanning, which may result in slower scanning speed.
- Introduced a new Check RTU-UI v2 component, see
- Document Data Extractor:
- Introduced a new Data Extractor RTU-UI v2 component, see
SBSDKUI2DataExtractorViewController
. - Added support for the front side of many more drivers license models.
- Added (partial) support for parsing of German addresses. For the respective ID cards, address parsing can be enabled via a new
SBSDKDeAddressParserConfiguration
. If the parsing was successful, the parsed address is stored as a child document (similar to MRZ). - Added support for multiple new document types:
- ID Cards from Brazil, Hong Kong, Macao, China
- Chinese Entry & Exit Permits
- The Document Data Extractor now detects whether a document is in focus already and only starts the heavy recognition pipeline when the image quality is suitable.
- Added a new method
setGlareDetectionConfiguration
method inSBSDKDocumentDataExtractorConfigurationBuilder
to fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfig
inSBSDKDocumentDataExtractorConfigurationBuilder
to precisely control the exclusion of frames that lack focus. - The Document Data Extractor can now detect glare in images. If fields are obstructed by glare, these fields will be returned with a validation status of
SBSDKGenericDocumentFieldValidationStatus.obstructed
. - Added case
errorStillFocussing
toSBSDKDocumentDataExtractionStatus
. - Returns the issuing series of German ID Cards as part of the returned document as the
Series
field. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStart
toSBSDKUI2DocumentScanningFlow
. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScan
toSBSDKUI2CameraScreenConfiguration
. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAdding
toSBSDKUI2ReviewScreenConfiguration
. If enabled the review screen will be opened showing the last page.
- Added property
- MRZ Scanner:
- Added support for non-ICAO conformant machine readable zones on US border crossing cards.
- Vehicle Identification Number Scanner:
- Introduced a new VIN RTU-UI v2 component, see
SBSDKUI2VINScannerViewController
.
- Introduced a new VIN RTU-UI v2 component, see
- General:
- 🚀 Improvements:
- Barcode Scanner:
- Added NSCopying support to
SBSDKBarcodeTrackedViewPolygonStyle
andSBSDKBarcodeTrackedViewTextStyle
. SBSDKBoardingPassBarcodeDocumentParser
now supports up to version 8 of the IATA-BCBP standard.- vCard document parser was improved.
- Added NSCopying support to
- Check Scanner:
- If image cropping is enabled and is successful, check recognition is performed on the crop instead of the original image.
- Credit Card Scanner:
- Added support for credit cards with an expiry date above the card number.
- Added support for credit cards with a name written in two lines.
- Document Data Extractor:
- General speed improvements.
- Now detects whether a document is in focus already and only starts the heavy recognition pipeline when the image quality is suitable.
- Classification for documents with MRZ is more stable.
- Added normalization before date recognition.
- More consistent usage of common field types.
- Improved maiden name processing for DePassport and DeIdCard.
- Now also supports the new German ID card format issued starting 2024.
- Document Quality Analyzer:
- Improved performance. Note: document quality scores may slightly change for the same input images when compared to the previous version of the DoQA.
- Document Scanner:
- Improved landscape-orientation layout of RTU-UIv2 screens.
- Increased performance for Document Scanner algorithms.
- The zoomed page view in the RTU-UIv2 review screen now closes when you finish zooming while being below the minimum zoom value.
- Medical Certificate Scanner:
- Date recognition in Medical Certificate forms is now based on the Scanbot OCR Engine and shows significant quality improvements.
- MRZ Scanner:
- On US border crossing permits, the document number is now returned in the correct field.
- Dates in MRZ now also support
parsedData
correctly.
- Scanbot OCR Engine:
- Improved performance of the Scanbot OCR engine.
- Text Pattern Scanner:
- General speed improvements.
- Now supports XNNPACK for faster inference.
- Barcode Scanner:
- 🐞 Bug fixes:
- General:
- Fixed some rare crashes in Credit Card Scanner, Document Data Extractor and MRZ Scanner.
- PDF Generation:
- Fixes a bug where PDFs with embedded OCR were invalid.
- Barcode Scanner:
- The carrier identifier for MaxiCode mode 3 might be encoded by using different codewords. Now all possible codewords are checked that encode the carrier identifier.
- vCard document parser now correctly processes the "FN" key as FormattedName.
- Fixed a bug in the Barcode Scanner RTU-UI v2 where the result callback was called multiple times.
- Credit Card Scanner:
- Fixed a crash if document detection was not successful due to an
OK_BAD_ASPECT_RATIO
status. - Setting the confirmation method to
interpolate
when scanning credit cards could result in unsuccessful recognitions although all data was extracted and verified. - Return correct scanning status if no fields are recognized.
- Fixed a crash if document detection was not successful due to an
- Document Data Extractor (DDE):
- When
IssuerNumber
is excluded on European health insurance cards, this no longer leads to theIssuerName
being incorrectly excluded. - MRZ fallback now also works when no accepted document types are selected.
- When
- Document Quality Analyzer:
- Fixed quality estimation for rotated images.
- Document Scanner:
- Fixed a bug in RTU-UI V2 Document Scanner where the document could not be captured in auto snap mode, when
enabledInAutoSnappingMode
is set to false inSBSDKUI2ShutterButton
. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerView
where the completion handler is not called when the view is a root view. Additionally, the view is now prevented from being automatically dismissed upon completion. - Fixed a bug in RTU-UI V2 Document Scanner where auto rotation was applied if no document was detected.
- Fixed a bug in RTU-UI V2 Document Scanner where the document could not be captured in auto snap mode, when
- Image Editing:
- Fixed a rare crash when the screen orientation changes.
- MRZ Scanner:
- Fixed an issue causing
nil
to be returned as a confidence of empty fields.
- Fixed an issue causing
- PDF Image Extractor:
- Fixes wrong orientation of extracted images when the PDF page has a transform applied.
- Storage Crypting:
- Fixed data corruption issues in AES encryption/decryption that could result in corrupted or partially corrupted files.
- General:
⚠️ Breaking changes:- General:
- Replaced all occurrences of the deprecated
AVCaptureVideoOrientation
enum by an equal enum namedSBSDKVideoOrientation
.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectable
andisAutomaticSelectionEnabled
fromSBSDKBarcodeTrackingOverlayConfiguration
. - Renamed parameter
isSelected
toisHighlighted
in tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate
:- Removed
didChangeSelectedBarcodes
method. - Added
shouldHighlight
method to determine barcode highlighting state. - Added
proposedStyle
parameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerState
toSBSDKCheckScannerState
.
�- Renamed the enum caserecognizing
toscanning
inSBSDKCheckScannerState
. - Removed
acceptedCheckTypes
fromSBSDKCheckScanner
and `SBSDKCheckScannerViewControl...
- Renamed enum
- General: