Release Notes 

CaptureSDK Version 4.47.0 

What's New: 

General

  • Removed class BIOTorch from API
  • Removed alive parameter from BIOImage

Face remote

Added customisation for the MLC liveness view. Documentation

Matcher Handler

  • Marked setters in the following classes as unavailable:
    • BIOTemplate
      • setBuffer
      • setUuid
    • BIOAuthenticationResult
      • setScore
      • setMatchesSuccessfully
    • BIOIdentificationResult
      • setCandidates
    • BIOMatchingCandidate
      • setUUID
      • setScore

Finger

  • fullCaptureTime marked as unavailable in the FingerCaptureOptions

Document

  • Introduced the DocumentGlareDetect plugin, which adds the capability to detect glare on documents.
  • The documentHandlerReadMRZ delegate of DocumentCaptureHandlerDelegate may return an MRZRecord with missing day, month, or year components. This case was previously considered an error.

Document remote

  • Added interopability with obj-c for the RemoteError

CaptureSDK Version 4.46.0 (16 May 2025) 

What's New: 

Face remote

  • Introduced new liveness capture mode - MultidimensionalLivenessCheck (MLC) - BETA version - not yet available within all environments. See integration details
    • Added new field failureReasons to FaceCaptureError
    • Added new case mlc in Liveness enum.
    • Added new feedbacks in FaceCaptureFeedback (for MLC liveness type):
      • faceInfoCenterMoveLeft
      • faceInfoCenterMoveRight
      • faceInfoCenterMoveUp
      • faceInfoCenterMoveDown
      • faceInfoOpenEyes
      • faceInfoMoveDarkerArea
      • faceInfoMoveBrighterArea
      • faceInfoMakeNeutralExpression
      • faceInfoMakeSmile
      • faceInfoNotSmiling
      • faceInfoSmileWider
  • A bug preventing from using own UI for remote face capture has been fixed. Providing nil as uiSettings parameter in FaceCaptureView.setup() method results in not using IDEMIA UI and the integrator has to use use case delegates to handle provide custom UI.

Face

Finger

  • Added a new property ensureFourFingersScanning. This property enforces scanning exactly four fingers in the CaptureSDK. Attempts to scan fewer fingers or use it alongside the amputatedFingers setting will result in an error, as amputee mode and four-finger scanning are incompatible.

Release NFCReader 2.1.1 (21 Mar 2025) 

What's New: 

General

  • XCFramework is available to download via CocoaPods.

CaptureSDK Version 4.45.2 (7 Mar 2025) 

What's New: 

General

  • Fixed the bug with the camera preview not starting on iPhone 16e.

CaptureSDK Version 4.45.1 (28 Feb 2025) 

What's New: 

General

  • XCFramework is available to download via CocoaPods for face, face_document and document variants. XCFrameworks are not yet supported with biometry, biometry_document, fingerprint variants.

Face Remote

  • Public key pinning can now be enabled in the Face Capture SDK.

CaptureSDK Version 4.45.0 (20 Dec 2024) 

What's New: 

General

  • The method BIOImage.toJPEG() has been improved to provide better size compression.
  • The activation error licenseSignatureVerificationFailed in LKMS has been removed. If there is a switch between app builds (Debug or App Store build), the LicenseManager will automatically resolve the license issue by reactivating it.

Face remote:

  • Added a new value deviceBlocked to the ErrorType enum. This value indicates that capture is blocked.
  • Added a new property, unlockDateTime, to the FaceCaptureError class, which returns an NSNumber. The property's value is set if deviceBlocked exists in the FaceCaptureError.

Finger

  • The capturedFingers:withResult:withError: callback has been extended with additional argument imagesToDisplay containing images for display purposes only. For matching, images shall be used as before.
    • Previous callback variant is now deprecated and remains available till 4.48.0 version release.
  • In version 4.44.0, the location in the FINGERS mode was detected by the algorithms. Starting from this version, finger and hand location (BIOImage.location) are computed in the same way as they were before 4.44.0, due to limitations in the algorithms.

Document

  • The properties: integrity, sharpness, reflections, lighting and badFraming have been removed from DocumentImageQualityIndicators.

Known issue

  • Rare crash when Fingerprint capture is used intensively.

CaptureSDK Version 4.44.0 (20 Sep 2024) 

What's New: 

General

  • BIOTorch and all of it related APIs have been made obsolete.

Finger

  • Added a new enumeration FingerQuality. Each value (unavailable, low, medium, high) in the enumeration represents a quality level, intended for UI display purposes.
    • The enumeration is available as quality parameter in the FingerTrackingInfo.
  • The process of acquiring fingerprints becomes significantly quicker.
    • Duration of the capture is not constant anymore.
  • The qualityScore parameter in the FingerCaptureResult has been marked as unavailable.
  • The fullCaptureTime method in the FingerCaptureHandler has been deprecated.
  • Before version 4.44.0, finger scanning in the FINGERS mode ensured the uniqueness of each returned finger in the delegate [FingerCaptureHandlerDelegate capturedFingers:images:withResult:withError:], regardless of the number of fingers returned. Now, if fewer than 4 fingers are captured in this mode, the bio-location of the fingers is marked as UNKNOWN. NOTE: This change is only noticeable when amputated fingers are not specified in the FingerCaptureOptions. Amputee mode functions as before.
  • Before version 4.44.0, finger and hand location (BIOImage.location) was computed based on hand side specified in the FingerCaptureOptions. Now, in the FINGERS mode, the location is detected by capture algorithms.

Face remote

  • Added LivenessProcessingDelegate that sends progress information on metadata upload.

Face offline matching:

  • Added new matching algorithm plugin: F6_5_LOW70. It is now default one and the only recommended one for selfie versus selfie matching.
    • Templates created with other algorithms can not be used for matching (authentication, identification) with this plugin.
  • Added BIOFaceTemplate type, extending BIOTemplate with:
    • Property qualityRawValue which is returning value of face quality integer value.
    • Property quality which is returning FaceTemplateQuality.
  • Deprecated (to be removed in 4.47.0):
    • Setter for score and matchesSuccessfully properties in BIOAuthenticationResult.
    • Setter for candidates properties in BIOIdentificationResult.
    • Setter for score and UUID properties in BIOMatchingCandidate.
    • Setter for buffer and uuid properties in BIOTemplate.

Release NFCReader 2.1.0 (07 Aug 2024) 

What's New: 

General

  • Added support for Spanish, Slovenian, and Ukrainian identity cards.
  • Added support for Slovenian, Turkish, Kenyan and Indonesian passports.
  • Updating dependencies in the library and fixing minor issues.
  • Library BiometricSDKUITutorial was renamed to NFCReaderTutorialView

CaptureSDK Version 4.43.0 (12 Jul 2024) 

What's New: 

General

  • Maven support becomes deprecated and will be removed in 4.46.0. See Migration Guide for details.

Face Remote

  • Added OAuth authorization as alternative for the apikey. See integration guide
    • New class AccessToken, which keeps OAuth information.
    • Added new type authorization: init(accessToken: AccessToken, baseUrl: URL) to the EnvironmentInfo.

Document

  • Added RemoteUseCase.timeoutDelegate. CaptureTimeoutDelegate is a delegate that notifes about a timeout, returning best image that was captured. It is called before and additionally to RemoteCaptureDelegate.captureDidFinish(remoteResult:) with RemoteResultStatus.timeout.

CaptureSDK Version 4.42.0 (29 Mar 2024) 

What's New: 

General

  • All variants have iOS 15.0 deployment target
  • BIOLicenseManager and all of it supporting types have become obsolete, in favor of LicenseManager.

Document

  • DocumentImageQualityIndicators is extended with additional values with information about failed auto-capture. Old values are deprected and available with new names.
  • DocumentCaptureOptions has a new propery feedbackSamplingTime that allows to control delay between feedback generated by auto-capture.
  • PDF417 auto-capture is improved, working faster with higher reliability.

NFCReader 2.0.0 (22 Mar 2024) 

What's New: 

  • NFC reading speed has been improved.
    • Minimum NFC Server version has changed and it is now 2.2.2.
  • NFCReader has iOS 15.0 deployment target.

CaptureSDK Version 4.41.1 (22 Jan 2024) 

What's New: 

Face:

  • Improved Passive Video capture experience - previously progress might change from any value to 100%. Currently progress changes are smoother.

NFCReader 1.2.2 (5 Jan 2024) 

What's New: 

  • Local database update.
  • Added possibility to use remote or local tutorial
  • Fixed issue with tutorial animations.

CaptureSDK Version 4.41.0 (21 Dec 2023) 

What's New 

General

  • Removed unavailable API:
    • BIOTrackingInfo
    • BIOFingerCaptureInfo
    • Two methods in FingerCaptureHandlerDelegate:
      • captureTracking:withError:
      • capturedFingers:withCaptureInfo:withError:
  • iOS 12 and 13 are not supported anymore.

Face

  • Old API FaceCaptureHandler has been marked as deprecated.

Document

  • Old API DocumentCaptureHandler has been marked as deprecated.

Document Remote

  • minDPI adjustments for document auto capture.
  • UHD resolution is unlocked for device starting with iPhone 6S and later.

NFCReader 1.2.1 (24 Nov 2023) 

What's New: 

  • Added possibility to set tutorial provider URLs (eg. for on-premise deliveries).
    • Added optional sdkExperience: SDKExperience field in NFCReader's Configuration.
    • Getter tutorialProvider in NFCReader is throwing MissingSdkExperienceConfigurationError when sdkExperience field is not provided to Configuration.

CaptureSDK Version 4.40.0 (16 Nov 2023) 

What's New: 

General

  • Update the target deployment from iOS 11 to iOS 12.
  • BIOTrackingInfo has been replaced by FingerTrackingInfo.

Face Remote

  • Improvement for face capture mode: Passive Video. Detection liveness is more reliable, false negative acquisition is reduced.

Finger

  • BIOFingerCaptureInfo class has been replaced by FingerCaptureResult
  • maxNumberOfCaptures parameter in FingerCaptureOptions has been obsoleted. Default number of capture is 2.
  • BIOTorch from BIOMode has been removed from API.

Document

  • minDPI adjustments for document auto capture
    • Please don't adjust minDPI value.
  • UHD resolution is unlocked for device starting with iPhone 6S and later (only offline interface). It means that captured image size is going to be significantly bigger.
  • DocumentCaptureModeMRZImageStillMedium in DocumentCaptureMode has been removed from API. Please use instead: DocumentCaptureModeMRZImageMedium
  • Deprecation of parameters in the DocumentImage :
    • sharpnessPercentage, integrityPercentage, qualityReflection.
    • these values are available from NSError under userInfo parameter with key: BIOCapturingErrorUserInfoKeyDocumentImageQualityIndicators and the value has type DocumentImageQualityIndicators.
    • See DocumentImageQualityIndicators in integration guide.
    • How to migrate to 4.40.0
  • The probability of capturing a blurry document photo has been reduced.

Known issues

  • Enabling video recording in document capture consumes a lot of device resources and noticeable slowdown is observed on older devices.

NFCReader 1.2.0 (17 Nov 2023) 

What's New: 

  • NFC location and tutorial animations are now fetched from a backend service. It means that connection issue errors may now be returned in TutorialProvider calls.
  • NFCLocation contains now additional optional field documentFeature if the document has additional features (like metal cover).
  • TutorialProvider contains now additional async variants of provideNFCLocation and provideAnimation methods.

CaptureSDK Version 4.39.1 

What's New: 

General

  • Simplified license management API. See integration guide.
  • License issues are now reported as separate failure type (invalidLicense) in New document, face and finger API.

Improvements

  • Improved document and finger capture on iPhone 14 Pro, iPhone 14 Pro Max, iPhone 15 Pro and iPhone 15 Pro Max.

Bug fixes

  • Removed redundant captureFinishedWithError call when document capture finished with timeout. Now, it is called only once with timeout error (previously there was also a call without error). No changes for document image, bar code and MRZ callbacks.

CaptureSDK Version 4.39.0 

The version has been omitted.

CaptureSDK Version 4.38.0 

What's New: 

General

  • Improved detection of the documents for high-end devices.
  • Added new finger capture mode which allows capture of latent fingerprint. Its integration is different than for current fingerprint modes (see integration guide). This approach will be used for each new mode.
  • Removed bitcode from binaries as support for it is deprecated since Xcode 14 and will be removed in future Xcode versions.

UIExtensions Version 2.6.0: 

What's New: 

General

  • Minor API changes have been introduced in BiometricSDKUIFinger. start(with:duration:) method is now deprecated in FingerCaptureView and DistanceIndicatorSettings have been renamed to DistanceIndicatorUISettings.
  • Added possiblity to show/hide finger capture UI elements via FingerCaptureUISettings.

CaptureSDK Version 4.37.1 

What's New: 

Bug fixes:

  • Fixed issue with PDF417 barcode scanning on iPhone 14 Pro (and Pro Max).
  • Fixed face capture crashing on older devices (iPhone 6, iPhone SE).
  • Fixed remote face capture current steps callbacks (in StepInfoDelegate).

CaptureSDK Version 4.37.0 

What's New: 

General

  • Support for creating capture options from configuration files has been removed.

Finger

  • Added possibility to get information whether the distance between the fingers and the phone lens is correct.
  • Deprecation of BIOTrackingInfo and BIOFingerCaptureInfo, which implies also deprecation of two methods in FingerCaptureHandlerDelegate.
  • Deprecation of maxNumberOfCaptures in FingerCaptureOptions.

UIExtensions Version 2.5.0: 

What's New: 

  • Added new component BiometricSDKUIFinger with view FingerCaptureView to easily integrate with distance lens API in Finger variant.

CaptureSDK Version 4.36.0 

What's New: 

FaceRemote

  • Added possibility to download captured face image in remote use case.
  • FaceImage object has been added to hold captured face image in FaceCaptureResult.
  • Improved remote use cases error handling.

Finger

  • Improved finger liveness check.

Document

  • ID1 capture updated to work with document oriented in portrait.

CaptureSDK Version 4.35.1 

What's New: 

FaceRemote

  • Changed API for method (void)captureFinishedWithEncryptedMetadata:(BIOEncryptedData *)encryptedMetadata withFaceImage:(BIOFaceImage *)faceImage; in RemoteFaceCaptureHandlerDelegate. Now it enables to access faceImage object after capture is finished.

UIExtensions Version 2.4.0: 

What's New: 

  • Added new component BiometricSDKUITutorial with view TutorialView to show animation in lottie format

Important: 

Previous release notes can be found in UIExtensions Release notes

NFCReader 1.1.0 

What's New: 

  • Added new API for getting information about phone NFC antenna location and document NFC antenna location TutorialProvider. TutorialProvider provides also animations base on NFC antenna location and document type.
  • NFCReader needs mrz to start NFC scanning.

CaptureSDK Version 4.35.0 

What's New: 

General

  • Added new API implementation for face capture based on use cases. For now only remote capture is available.

Face

  • FaceCaptureLivenessModeMedium has been removed from SDK.
  • All FaceLivenessSecurityLevelVeryHigh(0-8) levels has been removed.
  • FaceCaptureLivenessModeHigh has been renamed to FaceCaptureLivenessModeActive

Document

  • Changed name of CaptureView to DocumentCaptureView

CaptureSDK Version 4.34.3 

Bug fixes:

  • Document Capture feature is supported now on iPhone 14 Pro and iPhone 14 Pro Max.

CaptureSDK Version 4.34.2 

Bug fixes:

  • Improved scanning of ID1 documents and documents with a PDF417 barcode.

Known issues

  • Due to problems with focus, Document Capture feature is not supported on iPhone 14 Pro.

CaptureSDK Version 4.34.1 

Bug fixes:

  • Fixed bug that was allowing to succesfully finish capture without MRZ detected on the passport or PDF417 on the driving license.
  • Fixed bug in Remote Capture mode which was causing preview not visible on iOS 16 when XCode14 is used.

CaptureSDK Version 4.34.0 

What's New: 

General

  • RemoteUseCase in Document Capture can now detect mandatory and optional fields on the sides of document. When mandatory fields are not found on the document - capture fails.
  • Fixed bug with converting BIOImage to UIImage on iOS 16.

Finger

  • Removed deprecated properties from BIOTrackingInfo: biometricLocation and biometricModality, as consequence of this is removing initializers:
    • + (instancetype)bioTrakingWithBiometricLocation
    • - (instancetype)initWithBiometricLocation

CaptureSDK Version 4.33.0 

What’s New: 

FingerCapture:

  • Fingerprint detection/segmentation improvement.
  • Algorithm used to verify liveness of the scanned fingers has been improved - early adopter capability.
  • Disabling or enabling torch in finger capture options is now deprecated and will be removed in the following versions of the SDK. To achieve the best liveness verification results torch should be always on.
  • Bitcode has been disabled in variants with document capture capabilities.

CaptureSDK Version 4.32.1 

What’s New: 

Face:

  • Added new callback for face tracking info. receiveFaceTrackingInfo callback has been added. It conveys information about user's face and eyes position on a preview. Can be used to display additional guides in UI.

Bug fixes:

  • Fixed bug regarding missing exif note in images.

CaptureSDK Version 4.32.0 

What’s New: 

Face:

  • Improved passrate and fraud detection for modes FaceCaptureLivenessModeHigh and FaceCaptureLivenessModePassive.
  • Reduced the number of face liveness security levels to 3: FaceLivenessSecurityLevelLow, FaceLivenessSecurityLevelMedium and FaceLivenessSecurityLevelHigh. Marked all FaceLivenessSecurityLevelVeryHigh(0-8) levels as deprecated.

General:

  • Removed deprecated methods: startReplayingFile:withError and stopReplayingFile:withError. From now on RTV replay can be started by setting rtvFilePath in BIODebugDataSettings.

Bug fixes:

  • Fixed bugs regarding finger bio location mapping.

CaptureSDK Version 4.31.0 

What’s New: 

General:

  • Increased iOS target version from 8.0 to 11.0
  • Removed 32bit (armv7) support
  • XCFramework is available to download from the artifactory
  • Added new method in the ImageUtils for cropping images

Face:

  • Added new scanning mode: FaceCaptureLivenessModePassiveVideo
    • The mode only works for remote scanning with RemoteFaceCaptureHandler
    • The mode is not supported within FaceCaptureHandler
    • The new callbacks has been added within the RemoteFaceCaptureHandlerDelegate. They are defined in BIOPassiveVideoProtocol:
      • passiveVideoPreparationDidStart
      • passiveVideoPreparationDidEnd
      • passiveVideoOverlayDidUpdate:andPosition:orError:
      • passiveVideoProgressDidUpdate:orError:
  • Added tracking information ( BIOFaceTrackingInformation ) in BIOFaceImage , which contains such information as:
    • a face's position
    • eyes' positions
  • FaceCaptureLivenessModeMedium mode is deprecated now

Finger:

  • Finger tracing info has biometricLocation and biometricModality marked as depracated
  • Fingers' liveness score is deprecated now in BIOLivenessResult

Bug fixes:

  • Fixed some bugs for finger acquistion

CaptureSDK Version 4.30.0 

What’s New: 

  • Added new document capture API based on use cases - See new API in integration guide.
  • Added RemoteUseCase for document capture:
    • Front and back capture management - camera opens once and both sides can be captured in one session.
    • Capture options and requirements are coming from backend’s tenant configuration.
    • Best image and optional video are directly pushed to the backend without extra effort for integrator.

Bug fixes:

  • Fixed the torch issue with FingerPrints acquisition - torch was off during reattempt of finger capture.

CaptureSDK Version 4.29.1 

What’s New: 

Face:

  • Added support for the new remote server API (3.x.x version) - the new server implementation introduces monitoring of face liveness fraudulent attempts - when too many fraudulent request are attempted, delays are added between attempts

Document:

  • Changed default minDPI parameter values. For DocumentCaptureModeVeryLowID1 and DocumentCaptureModeBarcodeVeryLowID1 mode minDPI has been changed to 350 dpi (from 360). For all other modes minDPI is now 250 (120 previously). If the defaults are used, please verify if the new values meet your requirements.

Bug fixes:

  • Removed unintendedly visible debug logs

CaptureSDK Version 4.29.0 

What’s new: 

General:

  • Fixed small issues with colorspace in the image converter

Face:

  • Removed deprecated property livenessHintInfo in BIOFaceImage and removed the deprecated class BIOLivenessHintInfo.

Finger:

  • Added possibility to scan a hand with amputated fingers by setting a new parameter: FingerCaptureOptions.amputatedFingers. It replases the old one: numberOfFingers.
  • It's obligatory now to point which hand will be used during the scanning, when creating FingerCaptureOptions
  • Added new parameter FingerCaptureOptions.hand

Document:

  • Removed a deprecated capture modes: DocumentCaptureModeVeryLowA4 and DocumentCaptureModeMRZMediumVeryLowA4

CaptureSDK Version 4.28.1 

What’s new: 

General:

  • Added video recording to the capture capability.

Face:

  • Added a dedicated capture handler for remote scanning: RemoteFaceCaptureHandler.
  • Removed deprecated FaceCaptureMode.
  • Removed deprecated values from BIOCaptureInfo.
  • Fixed issues with a face metadata - an embedded image is full size.

Finger:

  • FingerCaptureOptions has a new parameter UHDResolutionEnabled that specifies if camera should work in UHD/4K resolution - an experimental API.
  • Removed deprecated FingerCaptureModes:
    • FingerCaptureModeLeftHand
    • FingerCaptureModeRightHand
    • FingerCaptureModeLeftHandAuthentication
    • FingerCaptureModeRightHandAuthentication

Document:

  • Fixed issues with scanning some PDF417 barcodes.

CaptureSDK Version 4.28.0 

The version has been omitted.

CaptureSDK Version 4.27.0 

What’s new:

General:

  • Added a new configuration file feature which allows to load capture options from a configuration file.
  • Added new algorithm plugin BIOAlgorithmPlugin_F6_0_IDD80.

Face:

  • FaceCaptureOptions has a new method + (instancetype _Nullable)createFromConfigurationFileWithError:(NSError**)error to create capture options from configuration file provided by CaptureSDK team.

Finger:

  • FingerCaptureOptions has a new method + (instancetype _Nullable)createFromConfigurationFileWithError:(NSError**)error to create capture options from configuration file provided by CaptureSDK team.

Document:

  • DocumentCaptureOptions has a new method + (instancetype _Nullable)createFromConfigurationFileWithError:(NSError**)error to create capture options from configuration file provided by CaptureSDK team.

Bug Fixes:

  • Fixed problem with - (void)captureFinishedWithError:(NSError *)error delegate method not called when DocumentCaptureModeBarcode or DocumentCaptureModeBarcodePDF417 mode was used for capturing.

CaptureSDK Version 4.26.0 

What’s new 

Face

  • Illumination mode has become obsolete
  • Enum BIOLivenessHintInfo has been deprecated

Finger

  • Set default liveness level to FingerCaptureLivenessTypeLow

Document

  • Added ESF plugin for digital watermark detection on US driving licenses.
  • These selected DocumentCaptureMode values have been deprecated:
    • DocumentCaptureModeMRZStillMedium
    • DocumentCaptureModeVeryLowA4
    • DocumentCaptureModeMRZMediumVeryLowA4
  • The OCREnable capture option has become obsolete

CaptureSDK Version 4.25.1 

What’s new 

Face

  • Ability to set default security level to high for every face capture mode
  • Ability to set default liveness mode to passive
  • Improved capture locking mechanism
  • Delegate method – (void)captureIsLockedFor:(NSInteger)seconds is now deprecated and called only after starting the capture when capture is locked. In order to get number of seconds remaining until capture is unlocked, use the timeToUnlock property of FaceCaptureHandler instead.
  • Added a new feedback status for BioCaptureingInfo , which is used to indicate that a user has stopped moving the device during a capture attempt

Finger

  • Merged modes FingerCaptureModeLeftHand and FingerCaptureModeRightHand into FingerCaptureModeFourFingers
  • Merged modes FingerCaptureModeLeftHandAuthentication and FingerCaptureModeRightHandAuthentication into FingerCaptureModeAuthentication
  • Added new mode FingerCaptureModeOneFinger for scanning only one finger (i.e., a thumb).
  • Added new option numberOfFingers in FingerCaptureOptions for **FingerCaptureModeFourFingers** mode, where an integrator may set the number of fingers which will be scanned

Document

  • Fixed MRZParser – It can now parse document numbers longer than 9 characters for TD1 and TD2 documents

Known issues

  • Currently, the DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices, etc.

CaptureSDK Version 4.25.0 

The version has been omitted.

CaptureSDK Version 4.24.0 

What’s new: 

Face:

  • Improved algorithms for the passive liveness mode.
  • Set default security level to very high for every face capture mode.

Document:

  • Added a new feedback status for the document capture: BIODocInfoLowLight - which indicates that there's no enough light to capture a document.

Bug Fixes: 

  • Fixed an automatic preview orientation change, Note: when an orientation changes during capturing, the capture will be reset.

Known issues: 

  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices etc.

CaptureSDK Version 4.23.1 

What’s new: 

  • Added possibility to encrypt face capture metadata for online liveness verification within the SDK

Known issues: 

  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices, etc.
  • Scanning documents with mrz code in still shot mode (with stillShootEnabled flag set to true) might result in returned image cropped incorrectly.

CaptureSDK Version 4.23.0 

What’s new 

  • Added passive liveness mechanism. Now it's possible to perform a liveness challenge without making any head movements. Use new FaceCaptureLivenessModePassive mode from FaceCaptureLivenessMode to activate this feature.

Known issues 

  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices, etc.
  • Scanning documents with mrz code in still shot mode (with stillShootEnabled flag set to true) might result in returned image cropped incorrectly.

CaptureSDK Version 4.22.0 

What’s new 

  • Added plugin mechanism. Now you can customize the face scanning & matching part of the SDK. An integrator can load:

Face capturing plugins:

  • FaceCapturePluginLite - recommended to use when an external server is used for liveness check (1.9 MB uncompressed, 1.8 MB compressed) - no need to load algorithm plugin
  • FaceCapturePluginNormal - recommended to use with an offline liveness check (needs one of algorithm plugins) (2.9 MB uncompressed, 2.8 MB compressed)
  • FaceCapturePluginCr2dMatching - a special capturing plugin, which adds additional matching checks during the liveness high check (needs one of algorithm plugins) (2.9 MB uncompressed, 2.8 MB compressed)

Face algorithm plugins:

  • BiometricSDKAlgorithmPlugin_F5_0_VID81 – This small face matching algorithm can be used when the matching accuracy is not a priority, or when using it only for face capturing. This algorithm has been used before SDK 4.22.0 as a built-in algorithm. (4.3 MB uncompressed, 3.3 MB compressed)
  • BiometricSDKAlgorithmPlugin_F5_4_LOW75 – This is a more accurate face matching algorithm. It is recommended that it be used with BIOMatcherHandler (14.9 MB uncompressed, 10.9 MB compressed)

WARNING: The algorithms are not compatible with each other. The templates generated by one of the algorithms cannot be processed with the other one, i.e., it's not possible to match a template generated with F5_0_VID81 against a template generated with F5_4_LOW75. F5_0_VID81 has been used before SDK 4.22.0 as a built-in algorithm. So if an integrator upgrades the SDK's version from a version earlier then SDK 4.22.0, they should continue using F5_0_VID81. If an integrator wants to change the algorithm in their solution, all the stored templates will need to be recreated with the new algorithm.

Bug Fixes 

Minor bug fixes.

Known issues 

  • Using document scanning with DocumentCaptureOptions.stillShootEnabled option turned on can cause a crash on older phones due to allowed memory excess. The memory peak can exceed 600 MB.
  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices etc.

CaptureSDK Version 4.21.2 

What’s new 

  • RemoteLogger is now build into the SDK and by default it automatically sends analytics data to IDEMIA's server in the EU. RemoteLogger can be disabled as described in the Getting Started section of the documentation.

Known issues 

  • Using document scanning with DocumentCaptureOptions.stillShootEnabled option turned on can cause a crash on older phones due to allowed memory excess. The memory peak can exceed 600 MB.
  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices, etc.

CaptureSDK Version 4.21.1 

What’s new 

  • Added support for bitcode
  • RemoteLogger is now a required dependency and by default it automatically sends analytics data to IDEMIAs server in the EU
  • LKMS v1 is now deprecated

Bug Fixes 

  • Fixed problem with face liveness status not working correctly

Known issues 

  • Using document scanning with DocumentCaptureOptions.stillShootEnabled option turned on can cause a crash on older phones due to allowed memory excess. The memory peak can exceed 600 MB.
  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices, etc.

CaptureSDK Version 4.21.0 

What’s new 

Added new variants of the SDK:

  • Face only (without internal liveness checking mechanism): This variant does not contain a matching mechanism, so for liveness checking purposes the server should be used.
  • Face only + document (without internal liveness checking mechanism): This variant does not contain a matching mechanism, so for liveness checking purposes the server should be used.

New variants sizes:

  • Face only: ~5.9 MB download size (~10.7 MB of a device's storage)
  • Face only + document: ~11.2 MB download size (~18.6 MB of a device's storage)

Changed (NSUInteger)BIOFingerCaptureInfo.score parameter's name and type to (NSNumber *)BIOFingerCaptureInfo.qualityScore, which now can be nil if non applicable.

Known issues 

  • Using document scanning with DocumentCaptureOptions.stillShootEnabled option turned on can cause a crash on older phones due to allowed memory excess. The memory peak can exceed 600 MB.
  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn't detect A4 documents like invoices, etc.

Bug Fixes 

  • Fixed non-working finger liveness check.
  • Minor bug fixes.

CaptureSDK Version 4.20.0 

What’s new 

  • Added new variant of the SDK: Finger only

  • FaceLiveness now has ISO 30107-3 certification – level1 and level2 (official certification will be available in January 2020). This certification is an evaluation improvement from an external lab.

  • Improved MASK detection for FaceLiveness– improved VIDEO detection

  • Size reduction:

    • Face + Finger + Document: ~17.4 MB download size (~28.3 MB of a device’s storage) - 40% reduction
    • Face + Finger: ~11.9 MB download size (~19.9 MB of a device’s storage) - 40% reduction
    • Document: 7.2 MB download size ( 12.6 MB of a device’s storage) - 33% reduction
    • Finger: ~3 MB download size (~6.3 MB of a device’s storage) - new

  • Extended minDPI parameter, now it can be set for all the document modes, which return DocumentImage.

  • Added additional securityLevel parameter’s levels. Now it’s available to set one of the face liveness security levels:

    • FaceLivenessSecurityLevelLow - FRR < 0.1%
    • FaceLivenessSecurityLevelMedium - FRR < 1%
    • FaceLivenessSecurityLevelHigh - FRR < 3%
    • FaceLivenessSecurityLevelVeryHigh - FRR < 5%
    • FaceLivenessSecurityLevelVeryHigh2 - FRR < 10% (new)
    • FaceLivenessSecurityLevelVeryHigh3 - FRR < 15% (new)
    • FaceLivenessSecurityLevelVeryHigh4 - FRR < 20% (new)
    • FaceLivenessSecurityLevelVeryHigh5 - FRR < 30% (new)

  • The illumination feature has been deprecated.

  • The fingers liveness check feature is now only available for FingerCaptureModeLeftHand and FingerCaptureModeRightHand modes. This feature is no longer supported for FingerCaptureModeLeftHandAuthentication and FingerCaptureModeRightHandAuthentication.

Known issues 

  • Using document scanning with the DocumentCaptureOptions.stillShootEnabled option turned on can cause a crash on older phones due to allowed memory excess. The memory peak can exceed 600 MB. Devices which may be affected by the issue (memory crash amount / total amount / percentage of total):

    • iPad1: 127MB/256MB/49%
    • iPad2: 275MB/512MB/53%
    • iPad3: 645MB/1024MB/62%
    • iPad4: 585MB/1024MB/57%
    • iPad Mini 1st Generation: 297MB/512MB/58%
    • iPod touch 4th gen: 130MB/256MB/51%
    • iPod touch 5th gen: 286MB/512MB/56%
    • iPhone4: 325MB/512MB/63%
    • iPhone4s: 286MB/512MB/56%
    • iPhone5: 645MB/1024MB/62%
    • iPhone5s: 646MB/1024MB/63%
    • iPhone6: 645MB/1024MB/62%
    • iPhone6+: 645MB/1024MB/62%

    More info: https://stackoverflow.com/posts/15200855/revisions

  • DocumentCaptureModeMRZMediumVeryLowA4 mode is not working properly. It doesn’t detect A4 documents like invoices etc.

Bug Fixes 

Minor bug fixes.

CaptureSDK Version 4.19.0 

What’s new 

  • Improved face liveness algorithms resulting in higher liveness security.

  • Added securityLevel parameter in FingerCaptureOptions. Now it’s available to set one of the liveness security levels:

    • FaceLivenessSecurityLevelLow – FRR < 0.1%
    • FaceLivenessSecurityLevelMedium – FRR < 1%
    • FaceLivenessSecurityLevelHigh – FRR < 3%
    • FaceLivenessSecurityLevelVeryHigh – FRR < 5%

  • Added new capture statuses for BIOCapturingInfo:

    • BIOCapturingInfoDeviceMovementDetected – Returned when an end-user tries to move their device instead of their head
    • BIOCapturingInfoNoFaceMovementDetected – Returned when SDK detects that an end-user is not moving

  • Added integration for the logging library so logging can be turned on and analytics data can be sent to a server. No personal information is sent to the server, only technical data, including: number of tries, success rate, failure rate, etc.

Bug Fixes 

Minor bug fixes.

CaptureSDK Version 4.18.2 

Bug Fixes 

  • Fixed BIODocumentAcquisitionQualityLevel values
  • Minor bug fixes

CaptureSDK Version 4.18.1 

Bug Fixes 

  • Minor bug fixes

CaptureSDK Version 4.18.0 

Bug Fixes 

  • Fixed problems with the finger capture preview sometimes not working correctly

What’s new 

  • Added missing nullability attributes – This might have impact how the SDK is used from the Swift language.
  • The FaceCaptureMode enum is now deprecated. For choosing the face capture mode, use FaceCaptureLivenessMode instead.
  • Added a maxNumberOfCaptures parameter in FingerCaptureOptions. It can be used to perform capture verification to ensure high quality images.
  • Added a livenessType parameter in FingerCaptureOptions. It can be used to perform liveness check verification to ensure that real fingers are captured.

CaptureSDK Version 4.16.0 

Bug Fixes 

What’s new 

  • Updated algorithms resulting in higher liveness security.
  • Flag stillShootEnabled in DocumentCaptureOptions is now disabled by default.

CaptureSDK Version 4.15.2 

Bug Fixes 

  • Fixed problem with MRZ name parsing in passports

CaptureSDK Version 4.15.1 

Bug Fixes 

  • Fixed a problem with document capture that stopped working in few modes after adding stillShootEnabled flag

CaptureSDK Version 4.15.0 

What’s new 

  • With the added stillShootEnabled flag in DocumentCaptureOptions, you can perform a capture based on a still image at the best possible resolution, instead of a video stream
  • DocumentCaptureModeDocumentImage has been removed. Use DocumentCaptureMode with stillShootEnabled flag set to YES instead.
  • Default value of maxCapturesBeforeDelay in FaceCaptureOptions has been changed from 3 to 10