initiateAgentKYCforUser
🔍 Overview
initiateAgentKYCforUser
is a post-login API used by agent users to initiate the KYC process on behalf of a newly created customer. It captures both document and biometric (selfie) details and allows storing the user's biometric template on the server.
Upon invocation:
- The REL-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.
📱 UI Requirement
The mobile app must present the following screens to the agent user during this workflow:
- 📄 Document Capture Screen (via SDK)
- 📷 Selfie Capture Screen (via SDK)
- ✅ Document Confirmation UI (custom)
- 🎯 Selfie Confirmation UI (custom)
- 🔐 Biometric Consent UI (custom)
📥 Parameters
Name | Type | Description |
---|---|---|
userId | String | Customer ID for whom KYC is done |
reason | String | Message defining reason for KYC flow |
📤 Return Type
Returns RDNAError
JSON indicating success or failure.
Code Snippets
React Native
RdnaClient.initiateAgentKYCforUser(userId, reason, (response) => {});
Flutter
rdna.initiateAgentKYCforUser(userId, reason);
Cordova
com.uniken.rdnaplugin.RdnaClient.initiateAgentKYCforUser(successCallback, errorCallback, [userId, reason]);
Native iOS
(RDNAError *)initiateAgentKYCforUser:(NSString *)userId reason:(NSString *)reason;
Native Android
RDNA.RDNAError initiateAgentKYCforUser(String userId, String reason);
🔁 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
onIDVAgentKYCResponse
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_AGENT_BIOMETRIC_AND_DOCUMENT_SCAN
. - Use this op mode in all related event response APIs.
Updated 3 months ago