🪪 Additional Document Scan Workflow – Ditto ID IDV SDK

This document explains the end-to-end process and API interactions involved in performing an Additional Document Scan using the Ditto ID IDV SDK.

🎯 Purpose

The Additional Document Scan feature enables the mobile app to request and capture a secondary identity document from a logged-in user. This may be required in scenarios such as:

• Multi-document KYC
• Policy-based re-verification
• Additional compliance or audit steps

🔄 Workflow (Step-by-Step)

1. ✅ User logs in to the mobile app.
2. 📲 App calls initiateIDVAdditionalDocumentScan(reason) to trigger the scan.
3. 🔔 SDK triggers event getIDVDocumentScanProcessStartConfirmation.
4. 🖼️ App displays a prompt explaining why the document is required and shows a Start button.
5. 👆 User taps Start.
6. 📤 App responds using setIDVDocumentScanProcessStartConfirmation(true, workflow).
7. 📸 SDK launches scanner and captures the document.
8. 🧠 SDK performs OCR and extracts document details.
9. 📥 SDK triggers getIDVConfirmDocumentDetails with OCR data.
10. 🧾 App shows the extracted fields for user review (e.g., Name, DOB).
11. 👤 User taps Confirm or Rescan:
    • If Confirm: setIDVConfirmDocumentDetails(true, mode)
    • If Rescan: setIDVConfirmDocumentDetails(false, mode)
12. ✅ SDK triggers onIDVAdditionalDocumentScan with the final results.
13. 🟢 App displays success screen or proceeds to the next step.

flowchart TD

    userLogsIn[User Logs In] --> onUserLoggedIn[SDK triggers onUserLoggedIn]
    onUserLoggedIn --> initiateIDVAdditionalDocumentScan[App calls initiateIDVAdditionalDocumentScan]
    initiateIDVAdditionalDocumentScan --> getIDVDocumentScanProcessStartConfirmation[SDK triggers getIDVDocumentScanProcessStartConfirmation]
    getIDVDocumentScanProcessStartConfirmation --> setIDVDocumentScanProcessStartConfirmation[App calls setIDVDocumentScanProcessStartConfirmation]
    setIDVDocumentScanProcessStartConfirmation --> initiateDocCapture[SDK initiates Document Capture]
    initiateDocCapture --> scanDoc[User scans Document]
    scanDoc --> onIDVAdditionalDocumentScan[SDK triggers onIDVAdditionalDocumentScan]

    %% Success Callback Styling
    style onUserLoggedIn fill:#d4fdd4,stroke:#228b22,stroke-width:2px
    style getIDVDocumentScanProcessStartConfirmation fill:#d4fdd4,stroke:#228b22,stroke-width:2px
    style onIDVAdditionalDocumentScan fill:#d4fdd4,stroke:#228b22,stroke-width:2px

    %% App-Initiated Call Styling
    style initiateIDVAdditionalDocumentScan fill:#ffe4b3,stroke:#ff8c00,stroke-width:2px
    style setIDVDocumentScanProcessStartConfirmation fill:#ffe4b3,stroke:#ff8c00,stroke-width:2px
    

🟩 Green - Callbacks issued by Ditto ID SDK
🟧 Orange - APIs invoked by the Client App

📦 APIs Involved

🧾 Example Screen Content

• “Please scan your secondary identity proof”
• “Ensure the document is in focus and readable”
• Buttons:
  • ✅ “Start Scan”
  • 🔁 “Rescan”
  • ✔️ “Confirm”

🧠 Notes

• This flow is available only after user login.
• The challengeMode in this flow is typically 11.
• The final result is received via the onIDVAdditionalDocumentScan event.