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

  1. getIDVConfirmDocumentDetails is triggered.
  2. Display scanned document and fields to user.
  3. User taps Confirm → call setIDVConfirmDocumentDetails(true, mode).
  4. SDK proceeds to getIDVSelfieProcessStartConfirmation.

If false is passed, SDK returns to document scanning step.


📥 Event Payload Fields

FieldTypeDescription
challengeModeIntegerThe mode of the IDV challenge, e.g., 8 for activation
response_dataJSONv3.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:

NameTypeDescription
isConfirmedBooleantrue = confirmed, false = rescan requested
challengeModeIntegerThe 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

CodeMessageAction
146IDV identity verification canceledShow error and possibly reinitiate scan
400Unable to process requestShow retry option