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 Ditto ID IDV SDK.


Upon invocation:

  • The Ditto 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

NameTypeDescription
reasonStringMessage defining reason for KYC flow

šŸ“¤ Return Type

Returns RDNAError JSON indicating success or failure.


Code Snippets

React Native
RdnaClient.initiateActivatedCustomerKYC(
  "User onboarding KYC",
  (response) => {
    console.log("KYC started", response);
  }
);
Flutter
rdna.initiateActivatedCustomerKYC("User onboarding KYC");
Cordova
com.uniken.rdnaplugin.RdnaClient.initiateActivatedCustomerKYC(
  function success(response) {
    console.log("KYC started", response);
  },
  function error(err) {
    console.error("KYC failed", err);
  },
  ["User onboarding KYC"]
);
Native iOS
RDNAError *error = [RDNA.sharedInstance initiateActivatedCustomerKYC:@"User onboarding KYC"];
Native Android
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

ActionDescription
"reinit-idv-document-scan"Restart document scan process.
"reinit-idv-selfie"Retry selfie capture.
"continue-flow"Proceed to biometric consent.
  1. getIDVBiometricOptInConsent

    • Developer must invoke setIDVBiometricOptInConsent.
  2. 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.