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
initiateIDVBiometricOptIn
Starts 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
getPassword
callback if user logged in with password
- SDK Triggers
getIDVSelfieProcessStartConfirmation
and user consent is submitted withsetIDVSelfieProcessStartConfirmation
- SDK starts selfie capture and liveness check.
- Triggers
onIDVOptInCapturedFrameConfirmation
with selfie frame status.
Updated 3 months ago