national-id-numbers

A collection of validators and parsers for national identification numbers.

Installation

npm install national-id-numbers

Usage

Use the NationalID class to validate or parse identifiers by passing a two-letter ISO country code and the ID number:

import { NationalID } from 'national-id-numbers';

NationalID.validate('EG', '29001010100015'); // true
const info = NationalID.parse('EG', '29001010100015');
console.log(info.governorate); // '01'

NationalID.validate('US', '012-12-0928'); // true

Alternatively, import specific country modules and call their exports directly:

import { EGY, USA } from 'national-id-numbers';

EGY.NationalID.validate('29001010100015');
USA.SocialSecurityNumber.validate('012-12-0928');

You can also import individual modules via sub-paths:

import { SocialSecurityNumber } from 'national-id-numbers/nationalid/usa/social_security.js';

Constants and utility helpers are exported from the package as well:

import { Gender, validateRegexp } from 'national-id-numbers';

Supported Countries

Currently Implemented (27 countries)

Missing Countries (High Priority)

Missing Countries (Medium Priority)

Contributing

Want to add support for a new country? Check out our Contributing Guide for detailed instructions.

Testing

npm test