Releases: doo/scanbot-sdk-ios-spm
Releases · doo/scanbot-sdk-ios-spm
7.0.6-Beta1
WARNING: Release Notes for version 7.0.6 not found!
7.1.0-RC10
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. - Added property
selectedZoomFactortoSBSDKUI2BarcodeScannerUIResultto retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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
setGlareDetectionConfigurationmethod inSBSDKDocumentDataExtractorConfigurationBuilderto fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfiginSBSDKDocumentDataExtractorConfigurationBuilderto 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- 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_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerViewwhere 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
nilto 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
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState.
�- Renamed the enum caserecognizingtoscanninginSBSDKCheckScannerState. - Removed
acceptedCheckTypesfromSBSDKCheckScannerand `SBSDKCheckScannerViewControl...
- Renamed enum
- General:
7.1.0
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. - Added property
selectedZoomFactortoSBSDKUI2BarcodeScannerUIResultto retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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
setGlareDetectionConfigurationmethod inSBSDKDocumentDataExtractorConfigurationBuilderto fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfiginSBSDKDocumentDataExtractorConfigurationBuilderto 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- 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_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerViewwhere 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
nilto 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
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState.
�- Renamed the enum caserecognizingtoscanninginSBSDKCheckScannerState. - Removed
acceptedCheckTypesfromSBSDKCheckScannerand `SBSDKCheckScannerViewControl...
- Renamed enum
- General:
7.1.0-RC9
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. - Added property
selectedZoomFactortoSBSDKUI2BarcodeScannerUIResultto retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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
setGlareDetectionConfigurationmethod inSBSDKDocumentDataExtractorConfigurationBuilderto fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfiginSBSDKDocumentDataExtractorConfigurationBuilderto 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- 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_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerViewwhere 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
nilto 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
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState.
�- Renamed the enum caserecognizingtoscanninginSBSDKCheckScannerState. - Removed
acceptedCheckTypesfromSBSDKCheckScannerand `SBSDKCheckScannerViewControl...
- Renamed enum
- General:
7.1.0-RC8
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. - Added property
selectedZoomFactortoSBSDKUI2BarcodeScannerUIResultto retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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
setGlareDetectionConfigurationmethod inSBSDKDocumentDataExtractorConfigurationBuilderto fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfiginSBSDKDocumentDataExtractorConfigurationBuilderto 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- 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.
- 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_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerViewwhere 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
nilto 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
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState.
�- Renamed the enum caserecognizingtoscanninginSBSDKCheckScannerState. - Removed
acceptedCheckTypesfromSBSDKCheckScannerandSBSDKCheckScannerViewController. - Introduced
acceptedCheckStandardsproperty in `SBSDKCheckScannerConfigu...
- Renamed enum
- General:
7.1.0-RC7
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. - Added property
selectedZoomFactortoSBSDKUI2BarcodeScannerUIResultto retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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
setGlareDetectionConfigurationmethod inSBSDKDocumentDataExtractorConfigurationBuilderto fine-tune the detection of glare over the fields. - Added a new method
setAutoFocusConfiginSBSDKDocumentDataExtractorConfigurationBuilderto 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- 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.
- 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_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerViewwhere 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 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
nilto 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
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState.
�- Renamed the enum caserecognizingtoscanninginSBSDKCheckScannerState. - Removed
acceptedCheckTypesfromSBSDKCheckScannerandSBSDKCheckScannerViewController. - Introduced
acceptedCheckStandardsproperty inSBSDKCheckScannerConfigurationto specify accepted check standards.
- Renamed enum
- Document Data Extractor:
- Removed the `SBSDKUIDataE...
- General:
7.1.0-RC6
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. - Added property
selectedZoomFactortoSBSDKUI2BarcodeScannerUIResultto retrieve the zoom factor used for the barcode scanning. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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.
- 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- Scanbot OCR Engine:
- Improved performance of the Scanbot OCR engine.
- Improved handling of special characters like umlauts when frame accumulation is used.
- 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.
- 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.
- Credit Card Scanner:
- Fixed a crash if document detection was not successful due to an
OK_BAD_ASPECT_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton. - Fixed a bug in RTU-UI V2 Document Scanner Swift UI component
SBSDKUI2DocumentScannerViewwhere 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 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
nilto 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.
- General:
⚠️ Breaking changes:- General:
- Replaced all occurrences of the deprecated
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState.
�- Renamed the enum caserecognizingtoscanninginSBSDKCheckScannerState. - Removed
acceptedCheckTypesfromSBSDKCheckScannerandSBSDKCheckScannerViewController. - Introduced
acceptedCheckStandardsproperty inSBSDKCheckScannerConfigurationto specify accepted check standards.
- Renamed enum
- Document Data Extractor:
- Removed the
SBSDKUIDataExtractorViewControllerclass and its related components as part of the DDE RTU-UI V1 removal. - Renamed
SBSDKDeDriverLicenseFrontandSBSDKDeDriverLicenseBacktoSBSDKEuropeanDriverLicenseFrontandSBSDKEuropeanDriverLicenseFrontBack. - By default, only German documents are now enabled for scanning. Previously all supported documents were enabled.
- Removed the
- Document Scanner:
- Changed the
inittoconvenience initinSBSDKUI2DocumentScannerController.
- Changed the
- **PDF Ima...
- General:
7.0.5-Beta4
WARNING: Release Notes for version 7.0.5 not found!
7.1.0-RC5
- 🎉 New:
- General:
- Added property
hardwareButtonsEnabledtoSBSDKUI2CameraConfiguration. If enabled, it allows zooming using camera control button (iPhone 16 series). - Added property
fpsLimittoSBSDKUI2CameraConfigurationandSBSDKUI2DocumentScannerCameraConfigurationto limit the rate of detections per second in normal performance mode. - Added property
didEndZoomHandlertoSBSDKZoomingImageScrollView. - Added analytics support with new classes:
SBSDKAnalyticsManager,SBSDKAnalyticsEvent,SBSDKAnalyticsFeature,SBSDKAnalyticsCategory,SBSDKAnalyticsEventName,SBSDKAnalyticsEventFactory, andSBSDKAnalyticsSubscriberfor tracking and managing SDK usage analytics.
- Added property
- Barcode Scanner:
- Added new class
SBSDKBarcodeItemSelectionfor managing collections of selected barcode items. - Added property
identityStringtoSBSDKBarcodeItemto uniquely identify barcodes across detection frames. SBSDKBarcodeItemhas a new fieldrawBytesEncodingsthat contains the precise character encoding information ofrawBytes.SBSDKBarcodeItemhas a new fieldstructuredAppendInfo. The Structured Append mode can be used to split a message across mulitple barcodes. If present, the corresponding information is returned.SBSDKBarcodeItemhas a new fieldglobalIndexwhich allows to identify a barcode across multiple frames.SBSDKBarcodeScannerConfigurationhas a new fieldaccumulationConfigwhich 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
captureHighResolutionImagein 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.
- 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
errorStillFocussingtoSBSDKDocumentDataExtractionStatus. - Returns the issuing series of German ID Cards as part of the returned document as the
Seriesfield. - Introduced a Document Verification API including document semantics verification capabilities.
- Introduced a new Data Extractor RTU-UI v2 component, see
- Document Scanner:
- Added property
showReviewScreenOnStarttoSBSDKUI2DocumentScanningFlow. If enabled, the scanner automatically navigates to the review screen when the flow starts. - Added property
openReviewAfterEachScantoSBSDKUI2CameraScreenConfiguration. If enabled the review screen is opened after each addition of a new page. - Added property
showLastPageWhenAddingtoSBSDKUI2ReviewScreenConfiguration. 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
SBSDKBarcodeTrackedViewPolygonStyleandSBSDKBarcodeTrackedViewTextStyle. SBSDKBoardingPassBarcodeDocumentParsernow 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
parsedDatacorrectly.
- Scanbot OCR Engine:
- Improved performance of the Scanbot OCR engine.
- Improved handling of special characters like umlauts when frame accumulation is used.
- 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.
- 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.
- Credit Card Scanner:
- Fixed a crash if document detection was not successful due to an
OK_BAD_ASPECT_RATIOstatus. - Setting the confirmation method to
interpolatewhen 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
IssuerNumberis excluded on European health insurance cards, this no longer leads to theIssuerNamebeing 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
enabledInAutoSnappingModeis set to false inSBSDKUI2ShutterButton.
- 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
nilto 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.
- General:
⚠️ Breaking changes:- General:
- Replaced all occurrences of the deprecated
AVCaptureVideoOrientationenum by an equal enum namedSBSDKVideoOrientation.
- Replaced all occurrences of the deprecated
- Barcode Scanner:
- Removed properties
isSelectableandisAutomaticSelectionEnabledfromSBSDKBarcodeTrackingOverlayConfiguration. - Renamed parameter
isSelectedtoisHighlightedin tracking overlay methods. - Changed delegate method signatures in
SBSDKBarcodeTrackingOverlayControllerDelegate:- Removed
didChangeSelectedBarcodesmethod. - Added
shouldHighlightmethod to determine barcode highlighting state. - Added
proposedStyleparameter to style-related delegate methods.
- Removed
- Removed properties
- Check Scanner:
- Renamed enum
SBSDKCheckRecognizerStatetoSBSDKCheckScannerState. - Renamed the enum case
recognizingtoscanninginSBSDKCheckScannerState.
- Renamed enum
- Document Data Extractor:
- Removed the
SBSDKUIDataExtractorViewControllerclass and its related components as part of the DDE RTU-UI V1 removal. - Renamed
SBSDKDeDriverLicenseFrontandSBSDKDeDriverLicenseBacktoSBSDKEuropeanDriverLicenseFrontandSBSDKEuropeanDriverLicenseFrontBack. - By default, only German documents are now enabled for scanning. Previously all supported documents were enabled.
- Removed the
- PDF Image Extractor:
- Removed parameter
scalingfrom all methods and replaced it by member variablescaleFactor.
- Removed parameter
- General:
7.0.5-Beta3
WARNING: Release Notes for version 7.0.5 not found!