package
Taxpayer Identification Number validator and masker
npm install tin-validatorGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Validate and mask Taxpayer Identification Number (TIN) from US and EU countries. A TIN may be an Employer Identification Number (EIN), an Individual Taxpayer Identification Number (ITIN) or a Social Security number (SSN).
Most of the functions default to US country as you can see in the documentation below. Also for US country, entityType is not required. When trying to validate EU TIN we need to set both paramenters country and entityType as TIN format varies from ech country and entity types.
For EU TIN validation, we first try to validate by using an online API provided by the European Commisision, if any error is received from this API (for example, if the API is down), then we run our internal validations instead.
Install the package via npm:
npm install tin-validator --saveisValid(value)This method validates if the given value is a valid Taxpayer Identification Number.
value (*): The string value to validate.options (object, optional):
country (string, optional): Country of document to validate (by default, US).entityType (string, optional): Possible values: natural-person and legal-entity. By default: natural-person.skipExternalValidations (boolean, optional): Only applicable for EU TIN. When set to true, it skips external API validation and uses only internal validation. This is useful for performance, offline scenarios, or testing. By default: false.(boolean): Returns whether the input value is a valid TIN or not.
isValid({});
// => false
isValid('9-0-0700000');
// => false
isValid('900-70-0000');
// => true
isValid('900700000');
// => true
isValid('123456789', { country: 'PT', entityType: 'natural-person' });
// => truemask(value)This method will help you protect this sensitive piece of information by obfuscating some digits.
value (*): The value to mask.options (object, optional):
country (string, optional): Country of document to mask (by default, US).entityType (string, optional): Regulation entity type (by default, natural-person).skipExternalValidations (boolean, optional): Only applicable for EU TIN. When set to true, it skips external API validation and uses only internal validation. This is useful for performance, offline scenarios, or testing. By default: false.skipValidations (boolean, optional): Applicable for US and EU TIN. When set to true, it skips all kind of validations. This is useful when calling mask() after calling isValid(). By default: false.(string): Returns the masked value by replacing value certain digits by 'X'.
mask({});
// Throws an Error.
mask('9-0-0700000');
// Throws an Error.
mask('900-70-0000');
// => XXX-XX-0000
mask('900700000');
// => XXXXX0000sanitize(value)This method will remove all non numeric characters from the value.
value (*): The value to sanitize.options (object, optional):
country (string, optional): Country of document to sanitize (by default, US).entityType (string, optional): Regulation entity type (by default, natural-person).(string): Returns the sanitized value containing only numeric characters.
sanitize('9-0 0700000');
// => 900700000
sanitize('900a7#$0foobar0000');
// => 900700000standardize(value)This method will standardize TIN values. Validators may accept TIN values for specific countries with formatting variations (e.g. omitting prefixes of zeros). Users should invoke this method prior value masking and DB persistence, as it returns the official version of the TIN.
value (*): The value to standardize.options (object, optional):
country (string, optional): Country of document to standardize (by default, US).entityType (string, optional): Regulation entity type (by default, natural-person).(string): Returns the standardized value.
standardize('123A', { country: 'MT' });
// => 0000123A
standardize('123-45-6789');
// => 123456789To test using a local installation of node.js:
npm testThe release of a version is automated via the release GitHub workflow. Run it by clicking the "Run workflow" button.
The methods on version 1 are the same as on version 2. The only change is that the methods were sync, while now they are async.
MIT
ruimarinho
ruipmarinho@gmail.com
Estimated unpacked size across 9 packages.
264.4 kB
Includes dependencies.
4 direct · 1 outdated
2.7.0
3.3.2
^1.0.0
1.0.1
^2.0.1
2.0.1
^1.0.0
1.0.0