getIDVConfirmDocumentDetails
📄 getIDVConfirmDocumentDetails
This event is triggered by the REL-ID SDK after completing document scan and OCR. The SDK provides the extracted document details and requests user confirmation via the mobile app before continuing to the next step (typically selfie capture).
🎯 Purpose
To present the user with OCR-derived document details (e.g., name, DOB) and collect consent. Developers must show a consent screen and respond using setIDVConfirmDocumentDetails
.
🖼️ Recommended User Interface
Display:
- Document image (front & back)
- Extracted user details like name, DOB, document number, etc.
- A Confirm and Rescan option
🔁 Workflow
getIDVConfirmDocumentDetails
is triggered.- Display scanned document and fields to user.
- User taps Confirm → call
setIDVConfirmDocumentDetails(true, mode)
. - SDK proceeds to
getIDVSelfieProcessStartConfirmation
.
If false
is passed, SDK returns to document scanning step.
📥 Event Payload Fields
Field | Type | Description |
---|---|---|
challengeMode | Integer | The mode of the IDV challenge, e.g., 8 for activation |
response_data | JSON | v3.0 JSON object with OCR results |
🧾 Sample Payload
{
"challengeMode": 8,
"response_data": "<<OCR Data v3.0 JSON>>"
}
📤 Response API: setIDVConfirmDocumentDetails
Call this API to indicate whether the user confirmed or rejected the document scan result.
Parameters:
Name | Type | Description |
---|---|---|
isConfirmed | Boolean | true = confirmed, false = rescan requested |
challengeMode | Integer | The same challengeMode received in the event |
If false, SDK re-triggers getIDVDocumentScanProcessStartConfirmation
.
💻 Code Snippets
React Native
EventEmitter.addListener('getIDVConfirmDocumentDetails', getIDVConfirmDocumentDetails);
RdnaClient.setIDVConfirmDocumentDetails(true, challengeMode, (response) => {});
Flutter
rdna.on(RdnaClient.getIDVConfirmDocumentDetails, getIDVConfirmDocumentDetails);
rdna.setIDVConfirmDocumentDetails(true, challengeMode);
Cordova
document.addEventListener('getIDVConfirmDocumentDetails', getIDVConfirmDocumentDetails, false);
com.uniken.rdnaplugin.RdnaClient.setIDVConfirmDocumentDetails(
successCallback, errorCallback, [true, challengeMode]
);
Native iOS
(void)getIDVConfirmDocumentDetails:(NSString *)documentDetails challengeMode:(RDNAChallengeOpMode)mode;
(RDNAError *)setIDVConfirmDocumentDetails:(BOOL)isConfirm challengeMode:(RDNAChallengeOpMode)opMode;
Native Android
void getIDVConfirmDocumentDetails(String documentDetails, int mode);
RDNA.RDNAError setIDVConfirmDocumentDetails(boolean isConfirm, int optMode);
⚠️ Error Handling
Code | Message | Action |
---|---|---|
146 | IDV identity verification canceled | Show error and possibly reinitiate scan |
400 | Unable to process request | Show retry option |
Updated 3 months ago