SFTP IntegrationNEW

SFTP Job Integration Service

#📌 Overview

The SFTP Job Integration Service allows external clients to submit job requests via CSV files placed in predefined directories on an SFTP server. Each directory corresponds to a specific template ID, which defines how the submitted data is processed. The system handles ingestion, request generation, execution, and result classification (success or error).

#🎯 Use Case

Clients often require a simple, secure, and decoupled way to submit data for processing without integrating directly with internal APIs. This service enables such integration through a structured file-drop mechanism using SFTP.

#🗂️ Configurable Directory Mapping

The system supports multiple jobs by associating each template name exactly with its own unique input/output directory structure, which is provided via a setup request. Each template name defines its own job configuration and SFTP directories.

📄 Example Configuration

{
  "Voter ID Verification": {
      "input_files_dir": "/sftp/template1/input",                    //directory where input files go
      "processed_files_dir": "/sftp/template1/processed",            //directory where files will be moved after processing
      "success_files_dir": "/sftp/template1/success",                //directory where report files will go after processing in case of successful completion 
      "error_files_dir": "/sftp/template1/error"                     //directory where report files will go after processing in case of failures, will contain the error that occurs   
    },
    "Sign request for template": {
      "input_files_dir": "/sftp/template2/input",                   //directory where input files go
      "processed_files_dir": "/sftp/template2/processed",           //directory where files will be moved after processing  
      "success_files_dir": "/sftp/template2/success",               //directory where report files will go after processing in case of successful completion 
      "error_files_dir": "/sftp/template2/error"                    //directory where report files will go after processing in case of failures, will contain the error that occurs   
    }
}

🧾 Directory Definitions

📌 Template names available

1. Bank Account Verification
2. Bulk MUT Presentation Creation
3. Bulk Nach Mandate Cancellation
4. Bulk Nach Mandate Creation
5. Bulk Nach Presentation Cancellation
6. Bulk Upi Mandate Cancellation
7. Bulk Upi Mandate Creation
8. Bulk Upi Presentations Cancellation
9. Create NACH Presentations
10. Create Upi Presentations
11. Driving Licence Verification
12. Estamp bulk consume
13. Estamp bulk upload
14. Estamp bulk upload zip
15. Estamp bulk upload zip and csv
16. Get Form variables
17. Get Template variables
18. IFSC Verification
19. Mandate Org Migration
20. PAN Verification
21. Reporting Service
22. Revnue Stamp bulk upload
23. Sign request for form
24. Sign request for template
25. Voter ID Verification
26. VPA Verification

#🔐 Security

• Clients have isolated access to only their assigned directories.
• SFTP credentials are securely stored and accessed.
• Only files in configured paths are processed.

#🔄 Workflow Summary

1. CSV File Drop Client drops .csv into input_files_dir. Ensure the file name for the csv is same as the request to be generated against. Example - Lets say a job template that is supposed to generate sign requests for a form with ID FTP2504151934402763BUEKMM4QN8KXN, the csv should be FTP2007151934402763BUEKMM4QN8KXN.csv with the corresponding contents
2. Detection & Association The system monitors all configured input directories and maps the file to the correct templateId.
3. Processing
   • CSV is parsed and validated.
   • Job logic specific to the templateId is applied.
4. File Routing
   • ✅ Success → success_files_dir
   • ❌ Error → error_files_dir
   • 📂 Optionally → processed_files_dir