initiateActivatedCustomerKYC

🔍 Overview

This API triggers the post-login KYC process for a user, including document scan, selfie capture, and biometric template storage (if user consents). It ensures that all necessary user identity verification steps are completed securely using the REL-ID IDV SDK.

Upon invocation:

• The REL-ID SDK triggers the full KYC flow including:
  1. Document scanning (getIDVDocumentScanProcessStartConfirmation)
  2. Document confirmation (getIDVConfirmDocumentDetails)
  3. Selfie capture (getIDVSelfieProcessStartConfirmation)
  4. Selfie confirmation (getIDVSelfieConfirmation)
  5. Biometric opt-in (getIDVBiometricOptInConsent)

🔐 Preconditions

• This is a post-login API.
• It must be used only when a user session exists.

🧑‍💻 User Flow Summary

1. Triggered post-login to begin KYC verification.
2. Captures document via scanner.
3. Captures and confirms selfie.
4. Asks user consent to store biometric template.
5. Finalizes KYC and returns status.

📱 Screens to be presented

The app should present the following:

• Consent screen before document scan
• Document details confirmation screen
• Consent screen before selfie capture
• Selfie match result and action selection
• Biometric opt-in consent screen

📥 Parameters

📤 Return Type

Returns RDNAError JSON indicating success or failure.

Code Snippets

RdnaClient.initiateActivatedCustomerKYC(
  "User onboarding KYC",
  (response) => {
    console.log("KYC started", response);
  }
);

rdna.initiateActivatedCustomerKYC("User onboarding KYC");

com.uniken.rdnaplugin.RdnaClient.initiateActivatedCustomerKYC(
  function success(response) {
    console.log("KYC started", response);
  },
  function error(err) {
    console.error("KYC failed", err);
  },
  ["User onboarding KYC"]
);

RDNAError *error = [RDNA.sharedInstance initiateActivatedCustomerKYC:@"User onboarding KYC"];

RDNAError error = RDNA.getInstance().initiateActivatedCustomerKYC("User onboarding KYC");

🔁 Workflow Events & Actions

1. getIDVDocumentScanProcessStartConfirmation

   • Developer must invoke setIDVDocumentScanProcessStartConfirmation.

2. getIDVConfirmDocumentDetails

   • Developer must invoke setIDVConfirmDocumentDetails.

   • If true → triggers getIDVSelfieProcessStartConfirmation.

   • If false → restarts document scan.

3. getIDVSelfieProcessStartConfirmation

   • Developer invokes setIDVSelfieProcessStartConfirmation.

4. getIDVSelfieConfirmation

   • Developer must invoke setIDVSelfieConfirmation.

👇 Actions for setIDVSelfieConfirmation

5. getIDVBiometricOptInConsent

   • Developer must invoke setIDVBiometricOptInConsent.

6. Completion Event: onIDVActivatedCustomerKYCResponse

   • Sent on KYC success or failure.

✅ On Success

• The SDK will invoke the events in sequence as per KYC flow
• On completion or failure, the event onIDVActivatedCustomerKYCResponse will be triggered

❌ On Failure

• Developer should handle errors as per RDNAError structure
• Error events can be triggered at any stage in the flow

📌 Developer Notes

• The RDNAChallengeOpMode used in this flow is: RDNA_IDV_API_BIOMETRIC_AND_DOCUMENT_SCAN.
• Use this op mode in all related event response APIs.