🔄 Event: getIDVBiometricOptInConsent

📘 Description

Triggered by the SDK when the Ditto ID IDV workflow requires the user’s consent to store their biometric template on the server. This ensures compliance with data privacy regulations.

🖥️ Screen to Present

• Explain why biometric data is being stored.
• Provide:
  • ✅ "Agree"
  • ❌ "Decline"

🧑‍💻 Platform Support

EventEmitter.addListener('getIDVBiometricOptInConsent', getIDVBiometricOptInConsent);

rdna.on(RdnaClient.getIDVBiometricOptInConsent, getIDVBiometricOptInConsent);

document.addEventListener('getIDVBiometricOptInConsent', getIDVBiometricOptInConsent, false);

(void)getIDVBiometricOptInConsent:(NSString *)userID
                          response:(RDNAChallengeResponse *)response
                     challengeMode:(RDNAChallengeOpMode)mode
                             error:(RDNAError *)error;

void getIDVBiometricOptInConsent(String userID, RDNAChallengeResponse response, int mode, RDNAError error);

📤 Response Format

{
  "userID": "ok",
  "idvResponse": "",
  "challengeMode": 8,
  "attemptsLeft": 0,
  "status": {
    "statusCode": 100,
    "statusMessage": "Success."
  },
  "error": {
    "longErrorCode": 0,
    "shortErrorCode": 0,
    "errorString": "Success"
  }
}

🧩 Field Definitions

🛠️ API: setIDVBiometricOptInConsent

🧭 Overview

This API must be called after the user chooses to opt in or opt out of biometric template storage.

📥 Parameters

🛠️ Response API: setIDVBiometricOptInConsent

Description:

This API set the user consent for the biometric opt in allow or cancels based on user input.

💻 API Usage

RdnaClient.setIDVBiometricOptInConsent(true, challengeMode, (response) => {});

rdna.setIDVBiometricOptInConsent(true, challengeMode);

com.uniken.rdnaplugin.RdnaClient.setIDVBiometricOptInConsent(
  successCallback,
  errorCallback,
  [true, challengeMode]
);

(RDNAError *)setIDVBiometricOptInConsent:(BOOL)isOptIn challengeMode:(RDNAChallengeOpMode) opMode;

RDNA.RDNAError setIDVBiometricOptInConsent(boolean isOptIn, int challengeMode);

Error Codes:

🧠 Best Practices

• Always present clear and legally compliant messaging to the user.
• Do not proceed until user has explicitly opted in or out.

❌ What Happens When isOptIn = false in setIDVBiometricOptInConsent

When the application submits setIDVBiometricOptInConsent with isOptIn = false, the SDK processes this as the user explicitly declining consent to store their biometric template on the server.

🔄 Outcome of isOptIn = false

1. 🚫 Biometric template is NOT stored on the Ditto ID server.
2. 📄 SDK records that the user has opted out.
3. 🔐 Biometric login from server will not be available in future sessions.
4. 🔁 Fallback authentication (password, OTP, or device biometrics) may be used instead.
5. ⚙️ Depending on backend policy:
   • The IDV flow may continue if opt-in is optional
   • Or may terminate/redirect if biometric storage is mandatory

🧭 Developer Recommendations

• ✅ Show a clear confirmation message like:

  "You’ve chosen not to store your biometric data. We’ll use alternative methods to verify you in future."

• 🔄 Ensure fallback mechanisms are available:

  • Password login
  • OTP/email-based verification
  • Device-native biometrics (Face ID, Fingerprint)

🧠 Notes

• Users may opt in later by re-triggering the biometric template challenge.
• The decision can be logged for compliance tracking.

✅ What Happens When isOptIn = true in setIDVBiometricOptInConsent

When the application submits setIDVBiometricOptInConsent with isOptIn = true, the Ditto ID SDK interprets this as the user providing explicit consent to store their biometric template securely on the server.

🔄 Outcome of isOptIn = true

1. 📦 Biometric template is stored securely on the Ditto ID server.
2. 🔐 Enables biometric-first login or passwordless authentication for future logins and verification flows.
3. 🧾 SDK logs consent for compliance purposes (e.g., GDPR, IT Act).
4. 🔄 The IDV workflow proceeds to the next step.

🧭 Developer Recommendations

• Show a confirmation message like:

  "Your biometric data has been securely stored. You can now enjoy faster, secure logins."

• Ensure your backend supports biometric authentication for the opted-in user.

🚀 Benefits

• Faster authentication
• Seamless onboarding or re-verification
• Reduced reliance on passwords or OTP