ifsc-code-validator
v1.0.1
Published
Zero-dependency validator, parser, and bank lookup for Indian IFSC (Indian Financial System Code) numbers.
Maintainers
Readme
ifsc-code-validator
Fast, zero-dependency validator, parser, and bank lookup for Indian IFSC (Indian Financial System Code) numbers in Node.js, browsers, and edge workers.
Features
- ⚡ Zero dependencies: Weighs under 5 KB gzipped.
- 🏛️ Bank Code Lookup: Includes registered RBI bank code dictionary (SBI, HDFC, ICICI, Axis, Kotak, Punjab National, etc.).
- 🔍 Strict & Lenient Modes: Validate format alone or verify against registered banks.
- 📦 Isomorphic: Works seamlessly in Node.js, Bun, Cloudflare Workers, Next.js, and browser environments.
- 📝 Full TypeScript Support: Shipped with complete type declarations.
Installation
npm install ifsc-code-validator
# or
yarn add ifsc-code-validator
# or
pnpm add ifsc-code-validatorQuick Start
1. Validate IFSC Code
import { isValidIFSC } from 'ifsc-code-validator';
// Strict validation (Format + checks if bank prefix exists in RBI registry)
isValidIFSC('SBIN0000001'); // true
isValidIFSC('HDFC0000001'); // true
isValidIFSC('INVALID123'); // false
isValidIFSC('ZZZZ0000001'); // false (Format valid, but unknown bank code)
// Lenient validation (checks 11-char IFSC format only: ^[A-Z]{4}0[A-Z0-9]{6}$)
isValidIFSC('ZZZZ0000001', { strict: false }); // true2. Parse Details
import { parseIFSC } from 'ifsc-code-validator';
const info = parseIFSC('HDFC0000001');
console.log(info);
/* Output:
{
valid: true,
ifsc: 'HDFC0000001',
bankCode: 'HDFC',
bankName: 'HDFC Bank',
branchCode: '000001',
isKnownBank: true
}
*/3. Get Bank Name from Prefix or IFSC
import { getBankName } from 'ifsc-code-validator';
getBankName('SBIN'); // 'State Bank of India'
getBankName('ICIC0000104'); // 'ICICI Bank'
getBankName('UNKNOWN'); // nullIFSC Format Specification
According to the Reserve Bank of India (RBI):
- Length: Exactly 11 alphanumeric characters.
- First 4 characters: Alphabetic bank identifier (e.g.
SBIN,HDFC). - 5th character: Always
0(reserved for future use). - Last 6 characters: Alphanumeric branch code.
License
MIT © vjymisal0
