id-doc-validator

A validator for different types of personal, entity and VAT IDs for multiple countries.

Supported Countries

Installation

To use the id-doc-validator library in your project, you can install it via npm or yarn:

npm install id-doc-validator
# OR
yarn add id-doc-validator

How to Use

isValidIdDoc

To validate personal identification documents, use the isValidIdDoc function. It takes three parameters:

• idDoc (string): The identification document number to validate.
• country (string): The alpha-2 country code following ISO 3166-1 (e.g., "ES" for Spain, "FR" for France).
• idDocType (string, optional): The type of identification document to validate. For a list of supported identification document types, please refer to the expanded view of the Supported Countries (to validate VAT, use isValidVat). If this parameter is not passed, the function will check if the passed id doc is valid for any of the supported id docs for the country.

isValidVat

To validate any VAT number from the list of Supported Countries, use the isValidVat function. It takes one parameter:

• vatNumber (string): The VAT number to validate. Should include the VAT country code. In most cases it coincides with the alpha-2 country code, with some exceptions (e.g., "EL" for Greece instead of "GR").

isValidViesVat

To validate a VAT number for an EU member state, use the isValidViesVat function. This function uses the API provided by the European Commission to validate the VAT number. It takes two parameters:

• vatNumber (string): The VAT number to validate. Should not include the country code.
• countryCode (string): The alpha-2 country code following ISO 3166-1 (e.g., "ES" for Spain, "FR" for France).

It returns an object with the following properties:

• isValid (boolean): Whether the VAT number is valid or not.
• userError (boolean): The error returned by the VIES API. If the request was successful, it will equal 'VALID' or 'INVALID'. If the request was not successful, it will return a string with the error code.
• vatNumber (string): The VAT number actually validated. For example, if the passed VAT number is "ES12345678", the returned VAT number will be "12345678", without the country code.

Please note that the VIES API is very limited in the number of requests it can handle. Please use moderately and expect the service to be unavailable at times.

supportedIdDocsByCountry

To get a list of supported identification documents for a country, use the supportedIdDocsByCountry function. It takes one parameter:

• country (string): The alpha-2 country code following ISO 3166-1 (e.g., "ES" for Spain, "FR" for France).

It returns an array of strings with the supported identification documents for the country.

supportedCountriesIdDoc

To get a list of supported countries for identification documents (not VAT), use the supportedCountriesIdDoc function. It takes no parameters.

It returns an array of strings with the supported countries.

supportedCountriesVat

To get a list of supported countries for VAT validation, use the supportedCountriesVat function. It takes no parameters.

It returns an array of strings with the supported VAT country codes for VAT validation.

Resources

• ISO 3166-1
• Consilium Europa - Check Document numbers
• VIES VAT number validation