initiateIDVBiometricOptIn
š Overview
The initiateIDVBiometricOptIn API is used to opt-in a logged-in user for biometric authentication by capturing and uploading their selfie to the REL-ID server. This is a post-login flow and depends on the userās current authentication session.
š„ļø Recommended Screen
The app should:
- Display a loading or biometric setup screen before the selfie capture.
- Guide the user through any OS-native authentication (biometric/pattern/password).
- Present a selfie preview and confirmation prompt post-capture.
š API to Trigger Biometric Opt-In
ā³ļø initiateIDVBiometricOptIn
initiateIDVBiometricOptInStarts the biometric enrollment flow. Authentication will be requested via OS or password prompt.
š§ React Native
RdnaClient.initiateIDVBiometricOptIn((response) => {});š¦ Flutter
rdna.initiateIDVBiometricOptIn();š Cordova
com.uniken.rdnaplugin.RdnaClient.initiateIDVBiometricOptIn(successCallback, errorCallback);š± Native iOS
(RDNAError *)initiateIDVBiometricOptIn;š¤ Native Android
RDNA.RDNAError initiateIDVBiometricOptIn();š Workflow and Follow-up Events
- SDK prompts user for authentication:
- OS biometric (Face ID / fingerprint / PIN)
- or invokes
getPasswordcallback if user logged in with password
- SDK Triggers
getIDVSelfieProcessStartConfirmationand user consent is submitted withsetIDVSelfieProcessStartConfirmation - SDK starts selfie capture and liveness check.
- Triggers
onIDVOptInCapturedFrameConfirmationwith selfie frame status.
Updated 9 months ago
