Skip to content

Repository files navigation

🛡️ FinShield AI

Financial Protection & Growth Suite for Indian Consumers

AI-powered analysis of Indian bank, NBFC, and credit card loan agreements — detecting RBI violations, calculating EMI deviations, and auto-generating regulatory escalation letters.

Top 10 Finalist (Out of 155 Teams) — DELTABUILD National Level Hackathon


🏆 Achievement

FinShield AI was built during DELTABUILD – National Level Tech Innovation Event, where our team CodeHawk secured a place in the Top 10 out of 155 teams.

📜 Certificates:
https://github.com/sarvan-2187/delta-build/tree/main/certificates


✨ What It Does

Feature Description
📄 Document Analysis Upload loan agreements and get instant AI-powered clause-by-clause review
⚖️ RBI Compliance Check Automatically flags violations against RBI guidelines and Fair Practices Code
💸 EMI Deviation Calculator Detects discrepancies between promised and actual EMI structures
📬 Escalation Letter Generator Produces ready-to-send complaint letters to banks, NBFCs, or the RBI Ombudsman
📊 Risk Scoring Rates agreement risk level so consumers know what they're signing

🧱 Tech Stack

Backend

  • FastAPI — high-performance async API framework
  • Groq (llama3-70b-8192) — ultra-fast LLM inference on the free tier
  • ChromaDB — vector storage for document embeddings and semantic search
  • ReportLab — PDF generation for escalation letters

Frontend

  • React + Vite + TypeScript — fast, type-safe UI development
  • TailwindCSS — utility-first styling
  • Framer Motion — smooth, production-grade animations

🚀 Quick Start

Prerequisites


1. Clone the Repository

git clone https://github.com/your-org/finshield-ai.git
cd finshield-ai

2. Backend Setup

cd backend
python -m venv venv

# Activate the virtual environment
source venv/bin/activate        # macOS/Linux
venv\Scripts\activate           # Windows

pip install -r requirements.txt

# Configure environment variables
cp .env.example .env
# → Open .env and add your GROQ_API_KEY

# Start the development server
uvicorn app.main:app --reload

The API will be available at http://localhost:8000.
Interactive docs at http://localhost:8000/docs.


3. Frontend Setup

cd frontend
npm install
npm run dev

The UI will be available at http://localhost:5173.


🗂️ Project Structure

finshield-ai/
├── backend/
│   ├── app/
│   │   ├── main.py           # FastAPI app entry point
│   │   ├── routers/          # API route handlers
│   │   ├── services/         # Business logic (analysis, PDF gen)
│   │   └── models/           # Pydantic schemas
│   ├── requirements.txt
│   └── .env.example
├── frontend/
│   ├── src/
│   │   ├── components/       # Reusable UI components
│   │   ├── pages/            # Route-level views
│   │   └── lib/              # API client, utilities
│   ├── package.json
│   └── vite.config.ts
└── README.md

⚙️ Environment Variables

Create a .env file in the backend/ directory based on .env.example:

GROQ_API_KEY=your_groq_api_key_here
CHROMA_PERSIST_DIR=./chroma_db

🤝 Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

  1. Fork the repo
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Commit your changes (git commit -m 'Add your feature')
  4. Push to the branch (git push origin feature/your-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License. See LICENSE for details.


Built with ❤️ to help Indian consumers navigate complex financial agreements

About

AI-powered analysis of Indian bank, NBFC, and credit card loan agreements - detecting RBI violations, calculating EMI deviations, and auto-generating regulatory escalation letters.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages