🔄 Event: getIDVDocumentScanProcessStartConfirmation

📘 Description

The getIDVDocumentScanProcessStartConfirmation event is triggered by the REL-ID SDK before initiating the document scan as part of the identity verification (IDV) workflows. It provides an opportunity for the mobile app to present information to the user and confirm their intent before starting the scan.

🎯 Purpose

To notify the app that a document scan is about to begin, allowing the developer to:

• Show instructions to the user.
• Collect user consent.
• Proceed with document scanning by invoking the corresponding API: setIDVDocumentScanProcessStartConfirmation.

🧑‍💻 Platform Support

📤 Response Format

{ "idvWorkflow" : 14 }

🧩 Field Definitions

🧠 Developer Notes

• This event can be used to display instruction guide and take user consent before start the document scan process.

  ---

✅ Recommended UI Usage

Display the following messages to the user:

• “We need to verify your identity.”
• “Please scan a valid document like a passport or driver’s license.”
• “Ensure good lighting and avoid glare on the document.”
• A Start or Proceed button, which when clicked, should call the response API.
• A Cancel or Close button, which when clicked, should call the response API with false value to terminate the flow.

🛠️ Response API: setIDVDocumentScanProcessStartConfirmation

Description:

This API starts the document scanning process or cancels it based on user input.

Parameters:

💡 Developer Actions

Error Codes:

💻 API Usage

EventEmitter.addListener(
  'getIDVDocumentScanProcessStartConfirmation',
  getIDVDocumentScanProcessStartConfirmation
);

RdnaClient.setIDVDocumentScanProcessStartConfirmation(true, idvWorkflow, (response) => {});

rdna.on(RdnaClient.getIDVDocumentScanProcessStartConfirmation, getIDVDocumentScanProcessStartConfirmation);

rdna.setIDVDocumentScanProcessStartConfirmation(true, idvWorkflow);

document.addEventListener(
  'getIDVDocumentScanProcessStartConfirmation',
  getIDVDocumentScanProcessStartConfirmation,
  false
);

com.uniken.rdnaplugin.RdnaClient.setIDVDocumentScanProcessStartConfirmation(
  successCallback, errorCallback, [true, idvWorkflow]
);

(void)getIDVDocumentScanProcessStartConfirmation:(RDNAIDVWorkflow)workflow;

(RDNAError*)setIDVDocumentScanProcessStartConfirmation:(BOOL)isConfirm
                                             idvWorkflow:(RDNAIDVWorkflow)workflow;

void getIDVDocumentScanProcessStartConfirmation(RDNA.RDNAIDVWorkflow idvWorkflow);

RDNA.RDNAError setIDVDocumentScanProcessStartConfirmation(boolean isConfirm, RDNA.RDNAIDVWorkflow idvWorkflow);

🔁 Next Steps

After a successful document scan, the SDK will trigger the next event:

• getIDVConfirmDocumentDetails: Developer must display scanned details and confirm with user.