Verify_India_API/README.md

VerifyIndia API

REST APIs for Indian data verification:

• IFSC Lookup
• Pincode Lookup
• GST Verification
• PAN Verification
• Bank Account Verification

Tech Stack

• Runtime: Node.js v20+
• Framework: Express.js
• Database: PostgreSQL
• Cache: Redis
• Auth: API Keys + JWT

Setup

1. Install dependencies:

npm install

2. Create a .env file with your settings (replace <PASSWORD>):

PORT=3000
NODE_ENV=development
DATABASE_URL=postgres://india_api_2025:<PASSWORD>@localhost:5434/india-api-tech4biz
# optional: JWT_SECRET, REDIS_URL, etc.

3. Start the server:

npm run dev

Project Structure

verify-india-api/
├── src/
│   ├── index.js
│   ├── routes/
│   ├── middleware/
│   ├── services/
│   ├── database/
│   └── cache/
├── data/
├── package.json
├── .env.example
└── README.md

API Key Format

vf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Authentication via header:

X-API-Key: vf_live_xxx

Response Format

Success:

{
  "success": true,
  "data": {},
  "meta": {
    "request_id": "req_xxx",
    "credits_used": 1,
    "credits_remaining": 999
  }
}

Error:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Description"
  }
}