initiateIDVAdditionalDocumentScan

📄 API Documentation: `initiateIDVAdditionalDocumentScan`

This API triggers the Additional Document Scan workflow. It can only be invoked after the user is authenticated (post-login). Once called, it:

Triggers the event getIDVDocumentScanProcessStartConfirmation for user consent.
On confirmation, launches the REL-ID IDV Document Scanner UI.
On completion, returns document details via the event onIDVAdditionalDocumentScan.

A document scan initiation screen asking for user permission with reason.
A "Start Scan" button that will respond to the consent event and initiate scanning.

React Native

RdnaClient.initiateIDVAdditionalDocumentScan(
  "KYC Verification",
  (response) => {
    // Handle RDNAError response
  }
);

Flutter

rdna.initiateIDVAdditionalDocumentScan("KYC Verification");

Cordova

com.uniken.rdnaplugin.RdnaClient.initiateIDVAdditionalDocumentScan(
  successCallback,
  errorCallback,
  ["KYC Verification"]
);

Native iOS

(RDNAError *)initiateIDVAdditionalDocumentScan:(NSString *)reason;

Native Android

RDNA.RDNAError initiateIDVAdditionalDocumentScan(String reason);

Parameter	Type	Description
`reason`	String	A specific reason for initiating document scan (e.g., "PAN Verification")

Cordova also includes:

Parameter	Type	Description
`successCallback`	Function	Called when the call succeeds
`errorCallback`	Function	Called if an error occurs

Event	Purpose
`getIDVDocumentScanProcessStartConfirmation`	Triggered immediately after this API is called to request user consent
`onIDVAdditionalDocumentScan`	Triggered after successful scan, returns results

The response is a RDNAError JSON, which includes:

Typical errors include:

Updated 3 months ago