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:
- Document scanning (
getIDVDocumentScanProcessStartConfirmation) - Document confirmation (
getIDVConfirmDocumentDetails) - Selfie capture (
getIDVSelfieProcessStartConfirmation) - Selfie confirmation (
getIDVSelfieConfirmation) - Biometric opt-in (
getIDVBiometricOptInConsent)
- Document scanning (
š Preconditions
- This is a post-login API.
- It must be used only when a user session exists.
š§āš» User Flow Summary
- Triggered post-login to begin KYC verification.
- Captures document via scanner.
- Captures and confirms selfie.
- Asks user consent to store biometric template.
- 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
| Name | Type | Description |
|---|---|---|
| reason | String | Message 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
-
getIDVDocumentScanProcessStartConfirmation- Developer must invoke
setIDVDocumentScanProcessStartConfirmation.
- Developer must invoke
-
getIDVConfirmDocumentDetails-
Developer must invoke
setIDVConfirmDocumentDetails. -
If
trueā triggersgetIDVSelfieProcessStartConfirmation. -
If
falseā restarts document scan.
-
-
getIDVSelfieProcessStartConfirmation- Developer invokes
setIDVSelfieProcessStartConfirmation.
- Developer invokes
-
getIDVSelfieConfirmation- Developer must invoke
setIDVSelfieConfirmation.
- Developer must invoke
š Actions for setIDVSelfieConfirmation
setIDVSelfieConfirmation| Action | Description |
|---|---|
"reinit-idv-document-scan" | Restart document scan process. |
"reinit-idv-selfie" | Retry selfie capture. |
"continue-flow" | Proceed to biometric consent. |
-
getIDVBiometricOptInConsent- Developer must invoke
setIDVBiometricOptInConsent.
- Developer must invoke
-
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
onIDVActivatedCustomerKYCResponsewill be triggered
ā On Failure
- Developer should handle errors as per
RDNAErrorstructure - Error events can be triggered at any stage in the flow
š Developer Notes
- The
RDNAChallengeOpModeused in this flow is:RDNA_IDV_API_BIOMETRIC_AND_DOCUMENT_SCAN. - Use this op mode in all related event response APIs.
Updated 4 months ago
