ssn-validation

ssn-validation

Validate and mask a U.S. Social Security Number (SSN). Validate and mask Canadian SIN's too.

Installation

Install the package via npm:

npm install ssn-validation --save

Usage

isValid(value)

This method validates if the given value is a valid Social Security Number.

Arguments

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

Returns

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

Example

isValid({});
// => false

isValid('0-1-1234567');
// => false

isValid('011-23-4567');
// => true

isValid('011234567');
// => 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('0-1-1234567');
// Throws an Error.

mask('011-23-4567');
// => XXX-XX-4567

mask('011234567');
// => XXXXX4567

---

Tests

To test using a local installation of node.js:

npm test

License

MIT