Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinitshahdeo/pan-aadhaar-ocr
Extract PAN and Aadhaar (UIDAI) card numbers from scanned images using OCR
https://github.com/vinitshahdeo/pan-aadhaar-ocr
aadhaar aadhaar-card aadhaar-kyc aadhaar-number-validator extractor ocr pan-card pan-number-finder parser
Last synced: 2 months ago
JSON representation
Extract PAN and Aadhaar (UIDAI) card numbers from scanned images using OCR
- Host: GitHub
- URL: https://github.com/vinitshahdeo/pan-aadhaar-ocr
- Owner: vinitshahdeo
- License: mit
- Created: 2023-09-07T20:29:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-11T13:58:02.000Z (over 1 year ago)
- Last Synced: 2024-05-01T13:55:54.187Z (9 months ago)
- Topics: aadhaar, aadhaar-card, aadhaar-kyc, aadhaar-number-validator, extractor, ocr, pan-card, pan-number-finder, parser
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/pan-aadhaar-ocr
- Size: 743 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PAN and Aadhaar OCR Extractor
A Node.js package for extracting PAN and Aadhaar card numbers from scanned images using Optical Character Recognition (OCR).
- **Validate PAN and Aadhaar cards with ease during KYC processes**.
- **Extract card details quickly from scanned images**.
- **Lightweight & performant package available on NPM**.
> **Learn more on [Dev.to](https://dev.to/vinitshahdeo/simplify-kyc-with-pan-and-aadhaar-card-ocr-2f33)**.
## Installation
You can install this package using **npm**:
```bash
npm install pan-aadhaar-ocr
```
Or, if you prefer using **yarn**:
```bash
yarn add pan-aadhaar-ocr
```
## Usage
```javascript
const {extractCardDetails} = require('pan-aadhaar-ocr');
const imagePath = 'path/to/your/image.jpg'; // Pass path to your PAN/Aadhaar image
const cardType = 'PAN'; // Card type can either be `PAN` or `AADHAAR`
extractCardDetails(imagePath, cardType)
.then((extractedDetails) => {
console.log(`PAN Number: ${extractedDetails.Number}`);
})
.catch((err) => {
console.error(err);
});
```
You can also use async-await:
```javascript
try {
const extractedDetails = await extractCardDetails(imagePath, cardType);
console.log(extractedDetails);
} catch (err) {
console.error('Something went wrong while extracting card details');
}
```
## Supported Card Types
### `PAN`
PAN ([Permanent Account Number](https://en.wikipedia.org/wiki/Permanent_account_number)) is a unique ten-character alphanumeric identifier issued by the [Income Tax Department](https://incometaxindia.gov.in/) of India. It is widely used for financial and tax-related purposes.
### `AADHAAR`
[Aadhaar](https://en.wikipedia.org/wiki/Permanent_account_number) is a 12-digit unique identity number issued by the Unique Identification Authority of India ([UIDAI](https://uidai.gov.in/)). It is used for various government and private sector services and is a crucial identification document in India.
## PAN & Aadhaar Validation
For KYC processes, use the following API to validate PAN and AADHAAR:
- [PAN Verification](https://developer.sandbox.co.in/reference/pan-verification-basic-api)
- [Aadhaar Verification](https://developer.sandbox.co.in/reference/aadhaar-okyc-generate-otp-api)
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
## License
This module is authored by [Vinit Shahdeo](https://peerlist.io/vinitshahdeo) and licensed under the [MIT License](./LICENSE).
Made with ❤️ by @vinitshahdeo for India 🇮🇳
