Get IDV Selfie Process Start Confirmation
🔄 Event: getIDVSelfieProcessStartConfirmation
getIDVSelfieProcessStartConfirmation📘 Description
The getIDVSelfieProcessStartConfirmation event is triggered by the REL-ID SDK before initiating the selfie capture process as part of the identity verification (IDV) workflows.
It provides an opportunity for the mobile app to present instructions to the user and confirm their intent before starting the selfie capture.
🎯 Purpose
To notify the app that the selfie capture process is about to begin, allowing the developer to:
- Show instructions to the user.
- Collect user consent.
- Proceed with selfie capture by invoking the corresponding API:
setIDVSelfieProcessStartConfirmation.
🧑💻 Platform Support
| Platform | Syntax |
|---|---|
| React Native | rdnaEventRegistery.addListener('getIDVSelfieProcessStartConfirmation', handler) |
| Flutter | rdnaClient.on(RdnaClient.getIDVSelfieProcessStartConfirmation, handler); |
| Cordova | document.addEventListener('getIDVSelfieProcessStartConfirmation', handler, false); |
| Native iOS | (void)getIDVSelfieProcessStartConfirmation:(RDNAIDVWorkflow)workflow; |
| Native Android | void getIDVSelfieProcessStartConfirmation(String response); |
📤 Response Format
{ "idvWorkflow" : 14 }🧩 Field Definitions
| Parameter | Type | Description |
|---|---|---|
| idvWorkflow | Enum | Indicates the workflow that triggered the selfie capture, such as Activation or KYC process. |
🧠 Developer Notes
- This event can be used to display an instruction guide and take user consent before starting the selfie capture process.
✅ Recommended UI Usage
Display the following messages to the user:
- “We need to verify your identity.”
- “Please ensure you’re in a well-lit area before taking your selfie.”
- “Position your face within the frame for accurate verification.”
- A Start / Proceed button, which when clicked, should call the response API.
- A Cancel / Close button, which when clicked, should call the response API with
falseto terminate the flow.
🛠️ Response API: setIDVSelfieProcessStartConfirmation
setIDVSelfieProcessStartConfirmationDescription
This API starts the selfie capture process or cancels it based on user input.
Parameters
| Parameter | Type | Description |
|---|---|---|
| isConfirm | Boolean | true to start capture; false to cancel and redirect to appropriate flow. |
| useDeviceBackCamera | Boolean | true to use back camera; false for front camera. |
| idvWorkflow | Enum | The same workflow enum received in the event. |
💡 Developer Actions
| Scenario | Developer Action |
|---|---|
| User agrees | Call setIDVSelfieProcessStartConfirmation(true, false, idvWorkflow) |
| User cancels | Call setIDVSelfieProcessStartConfirmation(false, false, idvWorkflow) |
| Error occurred | Show appropriate message from RDNAError object |
Error Codes
| Code | Message | Action |
|---|---|---|
| 146 | "IDV identity verification canceled by user" | Show cancellation screen or retry flow |
💻 API Usage
React Native
EventEmitter.addListener(
'getIDVSelfieProcessStartConfirmation',
getIDVSelfieProcessStartConfirmation
);
RdnaClient.setIDVSelfieProcessStartConfirmation(true, false, idvWorkflow, (response) => {});Flutter
rdna.on(RdnaClient.getIDVSelfieProcessStartConfirmation, getIDVSelfieProcessStartConfirmation);
rdna.setIDVSelfieProcessStartConfirmation(true, false, idvWorkflow);Cordova
document.addEventListener(
'getIDVSelfieProcessStartConfirmation',
getIDVSelfieProcessStartConfirmation,
false
);
com.uniken.rdnaplugin.RdnaClient.setIDVSelfieProcessStartConfirmation(
successCallback, errorCallback, [true, false, idvWorkflow]
);Native iOS
(void)getIDVSelfieProcessStartConfirmation:(RDNAIDVWorkflow)workflow;
(RDNAError*)setIDVSelfieProcessStartConfirmation:(BOOL)isConfirm
useDeviceBackCamera:(BOOL)useBackCamera
idvWorkflow:(RDNAIDVWorkflow)workflow;Native Android
void getIDVSelfieProcessStartConfirmation(String response);
RDNA.RDNAError setIDVSelfieProcessStartConfirmation(boolean isConfirm,
boolean useBackCamera,
RDNA.RDNAIDVWorkflow workflow);🔁 Next Steps
After a successful selfie capture, the SDK will trigger the next event:
getIDVConfirmSelfieDetails: Developer must display the captured selfie details and confirm with user.
Updated about 1 month ago
