# idscanner

> Read Passport and ID Swiped as Taken From OCR Swipe Readers using the Machine Readable Zone of Passports and IDs.

Latest version **1.0.6** (published 2019-01-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install idscanner
pnpm add idscanner
yarn add idscanner
bun add idscanner
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2019-01-19 |
| First published | 2019-01-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adam Strain |
| Maintainers | adam.strain.dev |
| Keywords | Passport, ID, Swipe, Scan, Read, OCR, MRZ, Parse |

## Links

- npm: https://www.npmjs.com/package/idscanner
- Repository: https://github.com/adam-strain-dev-repos/IDScanner
- Homepage: https://github.com/adam-strain-dev-repos/IDScanner#readme
- Issues: https://github.com/adam-strain-dev-repos/IDScanner/issues
- npm.io page: https://npm.io/package/idscanner

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) ^10.12.18

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2019-01-19
- 1.0.5 — 2019-01-19
- 1.0.4 — 2019-01-19
- 1.0.3 — 2019-01-19
- 1.0.2 — 2019-01-19
- 1.0.1 — 2019-01-19
- 1.0.0 — 2019-01-19

## README

#ID and Passport Swipe Parser

##Description
Designed for the use of Hotel/Youth Hostel/Accommodation providers. Will take the OCR string from an MRZ Scanner, for example the 3M CR100, and parse all of the data to an object containing all of the Passport/ID's personal data.

##Usage
Include the idreader package like so `var idscanner = require("idscanner");`.

*idreader* has one functional method **getIDData** which takes the string as read from the passport/id swipe machine.

*idreader* has one example method **returnTestData**.

##Example Usage
```
var idscanner = require("idscanner");

//ONCE YOU HAVE COLLECTED YOUR SWIPE FROM THE PASSPORT/ID SWIPE READER INSERT IT AS THE PARAMETER TO getIDData
var parsedData = getIDData("START\nOCR LINE 1: P<RUSMALBORSKYI<<KOVBOJ<<<<<<<<<<<<<<<<<<<<<\nOCR LINE 2: 7553279419RUS8712242M2104131<<<<<<<<<<<<<<02\nOCR LINE 3:\nMSR LINE 1:\nMSR LINE 2:\nMSR LINE 3:\nEND");

//TO GET AN EXAMPLE RESULT OBJECT OUT CALL returnTestData
var exampleParsedData = returnTestData();
```

---
_Source: https://npm.io/package/idscanner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._