uphold / tin-validator

Validate and mask a U.S. Taxpayer Identification Number (TIN)

tin-validator

Validate and mask a U.S. Taxpayer Identification Number (TIN). A TIN may be an Employer Identification Number (EIN), an Individual Taxpayer Identification Number (ITIN) or a Social Security number (SSN).

Status

Installation

Install the package via npm:

npm install tin-validator --save

Usage

isValid(value)

This method validates if the given value is a valid Taxpayer Identification Number.

Arguments

1. value (*): The value to validate.

Returns

(boolean): Returns whether the input value is a valid TIN or not.

Example

isValid({});
// => false

isValid('9-0-0700000');
// => false

isValid('900-70-0000');
// => true

isValid('900700000');
// => true

---

mask(value)

This method will help you protect this sensitive piece of information by obfuscating some digits.

Arguments

1. value (*): The value to mask.

Returns

(string): Returns the masked value by replacing value certain digits by 'X'.

Example

mask({});
// Throws an Error.

mask('9-0-0700000');
// Throws an Error.

mask('900-70-0000');
// => XXX-XX-0000

mask('900700000');
// => XXXXX0000

---

sanitize(value)

This method will remove all non numeric characters from the value.

Arguments

1. value (*): The value to sanitize.

Returns

(string): Returns the sanitized value containing only numeric characters.

Example

sanitize('9-0 0700000');
// => 900700000

sanitize('900a7#$0foobar0000');
// => 900700000

---

Tests

To test using a local installation of node.js:

npm test

To test using Docker exclusively:

docker-compose run --rm sut

Release

npm version [<newversion> | major | minor | patch] --message "Release %s"

License

MIT

tin-validator's Issues

Plan for 1.0.0 release

• Add strict mode option to isValid to consider dashes and spaces when validating or not.
• Add node 5 to the test matrix (https://github.com/seegno/tin/blob/master/.travis.yml#L4) or consider using docker-compose run --rm sut.
• Fix README title (Numbers -> Number)
• Invert order of "See" with the introduction (https://github.com/seegno/tin/blob/master/src/index.js#L3).
• Remove default importing in favor of importing the named function isValid* (https://github.com/seegno/tin/blob/master/src/index.js#L12).
• Remove isValid(tin) in favor of using the type only to mask the value (https://github.com/seegno/tin/blob/master/src/index.js#L51).
• Remove the "NOTE:" prefix (https://github.com/seegno/tin/blob/master/src/index.js#L27).
• Remove unnecessary return (https://github.com/seegno/tin/blob/master/src/index.js#L43).
• Rename tinType to type (https://github.com/seegno/tin/blob/master/src/index.js#L55).
• Rename to tin-validator.
• Update package.json (e.g. based on this one), with special focus on scripts.
• Update README to include lodash-like arguments (based on this).
• Update eslint-config-seegno to 2.0.0 and subsequently the rc file, including renaming to yml.

Improve dummy numbers detection

The current validation does not detect a series of dummy numbers. Please see this for more details.