blockpoint/vat24api-php

API wrapper for Vat24API

1.4 2025-05-21 11:44 UTC

Requires

• php: ^8.1

Requires (Dev)

• laravel/pint: ^1.0
• phpunit/phpunit: ^10.3.2
• spatie/ray: ^1.28

MIT

• Blockpoint

• Blockpoint
• vat24api-php

README

A PHP wrapper for the Vat24API service, which provides VAT and EORI number validation for EU and UK businesses. This package makes it easy to integrate VAT and EORI validation into your PHP applications.

https://vat24api.com/

Installation

You can install the package via composer:

composer require blockpoint/vat24api-php

Usage

// Create a new Vat24Api instance with your API key
$vat24api = new Blockpoint\Vat24Api\Vat24Api('your-api-key');

// Validate a VAT number
try {
    $response = $vat24api->validateVat('NL', '836176320B01');

    if ($response->hasError()) {
        echo "API Error: " . $response->getErrorMessage() . "\n";
        echo "Status Code: " . $response->getStatusCode() . "\n";
    } elseif ($response->isValid()) {
        echo "VAT number is valid!\n";
        echo "Company name: " . $response->getCompanyName() . "\n";
        echo "Company address: " . $response->getCompanyAddress() . "\n";
    } else {
        echo "VAT number is not valid!\n";
        echo "Reason: " . $response->getFaultString() . "\n";
    }
} catch (\Blockpoint\Vat24Api\Exceptions\Vat24ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
}

// Validate an EORI number
try {
    $response = $vat24api->validateEori('GB', '123456789000');

    if ($response->hasError()) {
        echo "API Error: " . $response->getErrorMessage() . "\n";
        echo "Status Code: " . $response->getStatusCode() . "\n";
    } elseif ($response->isValid()) {
        echo "EORI number is valid!\n";
        echo "Company name: " . $response->getCompanyName() . "\n";
    } else {
        echo "EORI number is not valid!\n";
        echo "Reason: " . $response->getFaultString() . "\n";
    }
} catch (\Blockpoint\Vat24Api\Exceptions\Vat24ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
}

Available Methods

Validate VAT Number

$response = $vat24api->validateVat('NL', '836176320B01');

You can also perform a mutual validation by providing a requester country code and VAT number:

$response = $vat24api->validateVat('NL', '836176320B01', 'GB', '123456789');

Validate EORI Number

$response = $vat24api->validateEori('GB', '123456789000');

Response Methods

The ValidationResponse object provides the following methods:

• isValid(): Returns whether the VAT/EORI number is valid
• hasError(): Returns whether the response contains an API error
• getErrorMessage(): Returns the error message if any
• getStatusCode(): Returns the HTTP status code
• getMessage(): Returns the status message
• getCountryCode(): Returns the country code
• getVatNumber(): Returns the VAT number
• getEoriNumber(): Returns the EORI number
• getValidationStatus(): Returns the validation status
• getFaultString(): Returns the fault string if validation failed
• getRequestDate(): Returns the request date
• getConsultationNumber(): Returns the consultation number
• getConsultationAuthority(): Returns the consultation authority
• getCompanyName(): Returns the company name
• getCompanyAddress(): Returns the company address
• toArray(): Returns the raw response data as an array

Testing

composer test

License

The MIT License (MIT). Please see License File for more information.