PHP Classes

PHP EU VAT Validation: Validate VAT number using VIES API

Recommend this page to a friend!
     
  Info   Example   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not enough user ratingsTotal: 444 All time: 6,225 This week: 38Up
Version License PHP version Categories
eu-vat-validator 1.0.9GNU General Publi...5Web services, Finances, Validation, P...
Description 

Author

This class can validate VAT number using VIES API.

It can send SOAP requests to the Europa VIES (VAT Information Exchange System) API Web server to perform validation of a given VAT number of a given country.

The class returns the business name, address and country code of the company of the given VAT number.

Picture of Pierre-Henry Soria
  Performance   Level  
Name: Pierre-Henry Soria <contact>
Classes: 49 packages by
Country: United Kingdom
Age: 31
All time rank: 37316 in United Kingdom
Week rank: 2 Up1 in United Kingdom Up
Innovation award
Innovation award
Nominee: 18x

Winner: 3x

Example

<?php
/**
 * @author Pierre-Henry Soria <pierrehenrysoria@gmail.com>
 * @copyright (c) 2017-2019, Pierre-Henry Soria. All Rights Reserved.
 * @license GNU General Public License; <https://www.gnu.org/licenses/gpl-3.0.en.html>
 */

require 'src/autoloader.php';

use
PH7\Eu\Vat\Provider\Europa;
use
PH7\Eu\Vat\Validator;

$oVatValidator = new Validator(new Europa, '0472429986', 'BE');

if (
$oVatValidator->check()) {
   
$sRequestDate = $oVatValidator->getRequestDate();
   
// Optional, format the date
   
$sFormattedRequestDate = (new DateTime)->format('d-m-Y');

    echo
'Business Name: ' . $oVatValidator->getName() . '<br />';
    echo
'Address: ' . $oVatValidator->getAddress() . '<br />';
    echo
'Request Date: ' . $sFormattedRequestDate . '<br />';
    echo
'Member State: ' . $oVatValidator->getCountryCode() . '<br />';
    echo
'VAT Number: ' . $oVatValidator->getVatNumber() . '<br />';
} else {
    echo
'Invalid VAT number';
}


Details

EU VAT Number Validator

A simple and clean PHP class that validates EU VAT numbers against the central ec.europa.eu database (using the official europa API).

EU VATIN validator; EU Flag

The Problem

Validate VAT numbers might be difficult and if you use a validation pattern to check if the format is valid, you are never sure if the VAT registration number is still valid.

The Solution

This PHP VAT validator library uses real-time data feeds from individual EU member states' VAT systems so you are sure of the validity of the number and avoid fraud with expired or wrong VAT numbers.

For example, this kind of validation can be very useful on online payment forms.

Composer Installation

  • Be sure PHP 7.0 or higher is installed
  • Install Composer (https://getcomposer.org)
  • Then, include it in your project:
composer require ph-7/eu-vat-validator

  • Then, include Composer's autoload (if not already done in your project)

    require_once 'vendor/autoload.php';
    

Manual Installation (the old-fashioned way)

If you don't use Composer, you can install it without Composer by including the following

require 'src/autoloader.php';

How to Use

Example

use PH7\Eu\Vat\Validator;
use PH7\Eu\Vat\Provider\Europa;

$oVatValidator = new Validator(new Europa, '0472429986', 'BE');

if ($oVatValidator->check()) {
    $sRequestDate = $oVatValidator->getRequestDate();
    // Optional, format the date
    $sFormattedRequestDate = (new DateTime)->format('d-m-Y');

    echo 'Business Name: ' . $oVatValidator->getName() . '<br />';
    echo 'Address: ' . $oVatValidator->getAddress() . '<br />';
    echo 'Request Date: ' . $sFormattedRequestDate . '<br />';
    echo 'Member State: ' . $oVatValidator->getCountryCode() . '<br />';
    echo 'VAT Number: ' . $oVatValidator->getVatNumber() . '<br />';
} else {
    echo 'Invalid VAT number';
}

Optimization (Suggestion)

Depending of the use of this library, it could be handy to cache the result specifically for each specified VAT number.

Requirements

About Me

I'm Pierre-Henry Soria, a passionate Software Engineer and the creator of pH7CMS.

Where to Contact Me?

You can by email at pierrehenrysoria+github [[AT]] gmail [[D0T]] com

Wordpress Plugin

VIES Validator WP plugin uses also this EU VAT Validation library for WooCommerce checkout, when you need to make sure that the VAT number is valid (that plugin was deleloped by WpZen, not me :smiley:).

References

VAT Information Exchange System (VIES)

License

Under General Public License 3 or later.


  Files folder image Files (13)  
File Role Description
Files folder imagesrc (1 file, 1 directory)
Files folder imagetests (1 directory)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file eu-flag.svg Data Auxiliary data
Accessible without login Plain text file example.php Example Example script
Accessible without login Plain text file phpunit.xml.dist Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files (13)  /  src  
File Role Description
Files folder imageVat (3 files, 1 directory)
  Accessible without login Plain text file autoloader.php Aux. Auxiliary script

  Files folder image Files (13)  /  src  /  Vat  
File Role Description
Files folder imageProvider (2 files)
  Plain text file Exception.php Class Class source
  Plain text file Validatable.php Class Class source
  Plain text file Validator.php Class Class source

  Files folder image Files (13)  /  src  /  Vat  /  Provider  
File Role Description
  Plain text file Europa.php Class Class source
  Plain text file Providable.php Class Class source

  Files folder image Files (13)  /  tests  
File Role Description
Files folder imageVat (1 file, 1 directory)

  Files folder image Files (13)  /  tests  /  Vat  
File Role Description
Files folder imageProvider (1 file)
  Plain text file ValidatorTest.php Class Class source

  Files folder image Files (13)  /  tests  /  Vat  /  Provider  
File Role Description
  Plain text file EuropaTest.php Class Class source

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:444
This week:0
All time:6,225
This week:38Up