Skip to content

API Root

Returns general information about the API, its status, and available endpoints.

Endpoint

GET /

Parameters

No parameters required.

Response Fields

Field Type Description
name string API name
version string API version
status string Current API status
description string Brief description of the API
documentation string URL to the API documentation
endpoints object Map of endpoint names to their URLs
contact string Support contact email

Example Response

{
  "name": "VATComply API",
  "version": "1.0.0",
  "status": "operational",
  "description": "VAT validation API, geolocation tools, and ECB exchange rates",
  "documentation": "https://www.vatcomply.com/docs",
  "endpoints": {
    "countries": "https://www.vatcomply.com/countries",
    "currencies": "https://www.vatcomply.com/currencies",
    "geolocate": "https://www.vatcomply.com/geolocate",
    "iban": "https://www.vatcomply.com/iban",
    "vat": "https://www.vatcomply.com/vat",
    "rates": "https://www.vatcomply.com/rates"
  },
  "contact": "support@vatcomply.com"
}