lekoala/tin

Provide validation tools for Taxpayer Identification Number

1.3 2020-03-31 12:48 UTC

This package is auto-updated.

Last update: 2022-04-29 01:18:04 UTC


README

Build Status Scrutinizer Code Quality Code Coverage Build Status codecov.io

Latest Stable Version Latest Unstable Version Total Downloads License Monthly Downloads Daily Downloads

Dependency Status Reference Status

You may want to use https://github.com/loophp/tin instead.

A library to validate TIN numbers for individuals. This is based on a java library, this is why the code does not reflect best practices in php.

Supported countries are:

  • Austria (AT)
  • Belgium (BE)
  • Bulgaria (BG)
  • Croatia (HR)
  • Cyprus (CY)
  • Czech Republic (CZ) - no check digit (but possible czechphp/national-identification-number-validator)
  • Denmark (DK)
  • Estonia (EE)
  • Finland (FI)
  • France (FR)
  • Germany (DE)
  • Greece (GR) - only size
  • Hungary (HU)
  • Ireland (IE)
  • Italy (IT)
  • Latvia (LV) - no check digit
  • Lithuania (LT)
  • Luxembourg (LU)
  • Malta (MT) - no check digit
  • Netherlands (NL)
  • Poland (PL)
  • Portugal (PT)
  • Romania (RO) - no check digit
  • Slovakia (SK) - only structure
  • Slovenia (SI)
  • Spain (ES)
  • Sweden (SE)
  • United Kingdom (UK) - only structure

If your country is not there, feel free to open an issue with your country code and a link to the specification. Ideally, if you can provide a PR with the algorithm and the test that would be even better :-)

Installation

Run

$ composer require lekoala/tin

Usage

To simply check the validity of a number

$result = TINValid::checkTIN($countryCode, $number);

If you want to get the reason why a number is invalid, you can use

try {
    TINValid::validateTIN($countryCode, $number);
}
catch(TINValidationException $e) {
    
}

If you want to see if a country is supported or not, you can simply use

$result = TINValid::isCountrySupported('be');

Links

TIN Algorithms - Public - Functional Specification

Taxpayer Identification Number

License

This package is licensed using the MIT License. Please have a look at LICENSE.md.