📡 onIDVActivatedCustomerKYCResponse API Documentation

🧾 Overview

The onIDVActivatedCustomerKYCResponse event is triggered by the REL-ID SDK upon completion of the activated customer KYC workflow. It serves as the final status notification for the entire flow, informing the mobile application whether the KYC was successful or encountered an error.

🎯 Purpose

To notify the app about the result of the initiateActivatedCustomerKYC process. This is used by mobile developers to handle end-of-KYC actions like navigating to success/failure screens or retrying failed operations.

🚀 Triggered After

This event is triggered after the user completes the following steps initiated by initiateActivatedCustomerKYC:

1. Document Scan and Confirmation
2. Selfie Capture and Confirmation
3. Biometric Opt-In Consent

🧾 Sample Payload

{
  "shortErrorCode": 0,
  "errorMessage": "Success",
  "status": 200,
  "kycStatus": "SUCCESS"
}

📥 Payload Fields

✅ Success Handling

• If kycStatus is "SUCCESS" and shortErrorCode is 0, show a success screen or move to next onboarding step.
• Log the completion in the app analytics (if applicable).

❌ Failure Handling

• If shortErrorCode ≠ 0 or kycStatus is "FAILED", show an appropriate failure message.
• Provide options to retry or contact support.

📌 Notes

• This event marks the conclusion of the activated customer KYC process.
• No additional REL-ID API calls are needed after this unless retry is initiated.