iOS Migration from v4
4Finger ID is now easier to integrate and customise over previous releases. Fingerprint export is integrated with enrol and authentication functions within a fewer number of frameworks. UI follows a fixed interface making it easily extendable and replaceable.
The method of integration remains very similar, but with a few key changes highlighted in this documents.
Frameworks
4Finger ID consists of just two frameworks. All previous 4Finger ID modules should be removed.
veridium4FBiometrics
- This contains the core logic of the biometric.veridium4FUI
- A UI for portrait mode and self capture.
In addition to the 4Finger ID modules you must also include the following dependencies from the Veridium SDK:
veridiumCore
veridiumAnalytics
veridium4FBiometrics
has some breaking changes as described in more detail below.
Selecting Digits to Export
4Finger ID can now be configured to capture any sub-set of digits via setting a list. For example, to capture both thumbs:
let fingers = Set([NSNumber(value: VeridiumFourFFingerChoice.THUMB_RIGHT.rawValue),
NSNumber(value: VeridiumFourFFingerChoice.THUMB_LEFT.rawValue)])
exportConfig.setFingers(fingers)
However, connivence methods are available, for example, to capture the left hand, without allowing the user to switch hands:
let hand = VeridiumFourFHandChoice.forceLeftHandEnroll;
exportConfig.setHand( hand )
[Note, Enroll and authentication operations are still limited to 4 finger capture]
Liveness
Liveness is tuned on and off via the ExportConfig
static class:
ExportConfig.setUseLiveness(true);
This version uses passive liveness. No additional action by the user is required.
Failure to pass liveness halts the capture process and the SDK returns a IVeridiumSDK#LIVENESS_FAILED
result.
UI Selection
To register a biometric enroler, authenticator, or exporter, use the register methods provided by Veridium4FUI
in your app delegate:
VeridiumSDK.shared.register4FUIEnroller();
VeridiumSDK.shared.register4FUIAuthenticator();
VeridiumSDK.shared.register4FUIExporter();
UI Customisation
The new UI implementation is not compatible with previous releases. Customisations will required migration to the new UI architecture. See User Interface
section of 4FingerID Biometric Integration iOS for details on extending the UI for customisation.
Performing Export
VeridiumBiometrics4FExService
has been renamed VeridiumBiometricsFourFService
. Use as previously, calling VeridiumBiometricsFourFService .exportTemplate
.
To support future advanced functionality, it is required that do_export
is set true
for any export operation (exportConfig.do_export = true;
).
Finger Selector Module
The finger selection UI module has been refactored for simpler use. Intuitively, users now select the fingers they wish to capture, not those that are missing. The iOS modules is now named VeridiumFingerSelector
. Please consult the integration guide for updated usage.