onIDVAdditionalDocumentScan
📄 Event Documentation: onIDVAdditionalDocumentScan
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
Field | Type | Description |
---|---|---|
userID | String | The user's unique identifier |
challengeMode | Int | Should be 11 for Additional Document Scan |
idvResponse | JSON | OCR data captured and structured in v3.0 format |
error | Object | Standard RDNAError with error codes and messages |
status | Object | Includes 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
Code | Message | Developer Action |
---|---|---|
100 | Success | Proceed with displaying or storing data |
400 | Unable to process | Show retry option or alert user |
Updated 3 months ago