onIDVAdditionalDocumentScan

📄 Event Documentation: onIDVAdditionalDocumentScan

🧭 Overview

This event is triggered by the REL-ID SDK after a successful additional document scan initiated using initiateIDVAdditionalDocumentScan. It provides the app with the scanned OCR results and status metadata for further validation or workflow continuation.


🖥️ Screen to Present

  • A summary screen displaying the extracted document details from OCR.
  • Allow the user to review and confirm or report incorrect info.

📥 Sample Payload

{
  "userID": "user123",
  "challengeMode": 11,
  "idvResponse": "<<OCR JSON v3.0>>",
  "error": {
    "longErrorCode": 0,
    "shortErrorCode": 0,
    "errorString": "Success"
  },
  "status": {
    "statusMessage": "Success",
    "statusCode": 100
  }
}

🔑 Payload Field Details

FieldTypeDescription
userIDStringThe user's unique identifier
challengeModeIntShould be 11 for Additional Document Scan
idvResponseJSONOCR data captured and structured in v3.0 format
errorObjectStandard RDNAError with error codes and messages
statusObjectIncludes a code and message indicating the result

💡 Typical Use

  • Display the document content to user for confirmation.
  • Log audit or submit to server if required.
  • Trigger next step in verification or show a success message.

🔄 Event Registration (Platform Code)

React Native
EventEmitter.addListener('onIDVAdditionalDocumentScan', onIDVAdditionalDocumentScan);
Flutter
rdna.on(RdnaClient.onIDVAdditionalDocumentScan, onIDVAdditionalDocumentScan);
Cordova
document.addEventListener('onIDVAdditionalDocumentScan', onIDVAdditionalDocumentScan, false);
Native iOS
(void)onIDVAdditionalDocumentScan:(NSString *)userID
                  documentDetails:(NSString *)documentDetails
                           status:(RDNARequestStatus *)status
                    challengeMode:(RDNAChallengeOpMode)mode
                            error:(RDNAError *)error;
Native Android
void onIDVAdditionalDocumentScan(String userID, String documentDetails, int mode, RDNARequestStatus status, RDNAError error);

⚠️ Error Handling

CodeMessageDeveloper Action
100SuccessProceed with displaying or storing data
400Unable to processShow retry option or alert user