Alexander Nitrovich

Posted on Jul 16 • Originally published at blog.eurovalidate.com

Validate EU VAT in Flask

#api #tutorial #webdev

Validating EU VAT numbers in Flask applications ensures compliance with European tax requirements for businesses. This becomes crucial for SaaS and e-commerce platforms operating across Europe. In this guide, we'll walk through setting up a Flask endpoint to validate EU VAT numbers using an external API service. You'll learn how to construct a complete flow from input handling to calling the EuroValidate API and processing responses.

Introduction

The validation of EU VAT numbers is a regulatory requirement for businesses transacting across European borders, allowing verification of VAT number validity through services like the VAT Information Exchange System (VIES). This tutorial focuses on providing a hands-on implementation in Flask, using the EuroValidate API for accurate, reliable VAT validations. Our goal is to equip developers with a practical guide to integrate VAT validation into Flask applications, ensuring compliance and accurate data processing.

Prerequisites and Setup

To follow this tutorial, ensure you have the following tools and environment ready:

Python 3.x: Ensure Python is installed on your system.
Flask: A lightweight WSGI web framework for Python. Install it using pip:

  pip install Flask

Requests Library: For making HTTP requests to the EuroValidate API:

  pip install requests

It's recommended to use a virtual environment to manage dependencies. Set this up with:

python -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate

Understanding EU VAT Validation

EU VAT validation involves verifying the authenticity of a VAT number using a service like VIES or a third-party service like EuroValidate. These services return crucial information such as country code, validity status, company name, and address, if available. Errors may occur if VAT numbers are malformed or the service is unreachable, necessitating robust error handling.

Building the Flask Endpoint for VAT Validation

Let's create a simple Flask application with a route to handle VAT validation requests:

from flask import Flask, request, jsonify
import requests

app = Flask(__name__)

def validate_vat(vat_number):
    # EuroValidate API endpoint for VAT validation
    url = f"https://api.eurovalidate.com/v1/vat/{vat_number}"
    try:
        response = requests.get(url, timeout=5)
        response.raise_for_status()
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error validating VAT: {e}")
        return None

@app.route('/validate-vat', methods=['GET'])
def validate_vat_endpoint():
    vat_number = request.args.get('vat')
    if not vat_number:
        return jsonify({"error": "VAT number is required"}), 400

    result = validate_vat(vat_number)
    if result is None:
        return jsonify({"error": "Failed to validate VAT number"}), 500

    return jsonify(result), 200

if __name__ == '__main__':
    app.run(debug=True)

Code Explanation

Import Necessary Libraries: Import Flask for web framework operations and requests for HTTP requests.
Define Validation Function: validate_vat() communicates with the EuroValidate API and processes responses.
Setup Route: /validate-vat handles GET requests, validating provided VAT numbers and returning results or errors.

Integrating with the VAT Validation Service

Utilize the requests library to make API calls:

Response Handling: Convert the API response to JSON, handling connectivity issues or API errors with exceptions.
Logging and Returning Results: Return structured JSON to the client, including any error messages.

Valid and Invalid Response Examples

Valid VAT Response for NL820646660B01:

{
  "vat_number": "NL820646660B01",
  "country_code": "NL",
  "status": "valid",
  "company_name": "Example BV",
  "company_address": "Keizersgracht 123, 1015CJ Amsterdam",
  "request_id": "req_123456",
  "meta": {
    "confidence": "high",
    "source": "EuroValidate",
    "cached": false,
    "response_time_ms": 230
  }
}

Invalid VAT Response:

{
  "vat_number": "XX123456789",
  "country_code": "XX",
  "status": "invalid",
  "request_id": "req_654321",
  "meta": {
    "confidence": "low",
    "source": "EuroValidate",
    "cached": false,
    "response_time_ms": 250
  }
}

Code Walkthrough and Best Practices

Ensure your Flask application adheres to modular design principles. Capture error scenarios and log them properly. Consider securing API access and regularly updating dependencies.

Testing the VAT Validation Endpoint

Test your endpoint using tools like cURL or Postman:

curl -G "http://localhost:5000/validate-vat" --data-urlencode "vat=NL820646660B01"

This checks the functionality and handles edge cases such as missing parameters and invalid VAT formats.

Conclusion and Next Steps

By now, you've learned how to incorporate EU VAT validation into a Flask application. Beyond this tutorial, consider advanced techniques like caching valid responses, handling API limits, and expanding validations for broader data types. Start experimenting with this code and explore our EuroValidate API Documentation for more advanced examples.

Call to Action

Begin validating today by getting your free API key at EuroValidate. We encourage feedback and contributions to improve future tutorials. Subscribe for more insights into API integrations and Flask development.

DEV Community