Docs API Reference Ecommerce/bff/ecommerce/vies/detail

/bff/ecommerce/vies/detail

Validates an EU VAT identifier through the VIES REST API and caches the result for 4 weeks. Returns the validity flag, registered name, address, the VIES request date, and a UI hint (suggestReverseCharge) that is true for valid non-CZ EU VAT IDs — the typical case where the admin should set the contact's reverseCharge flag.

EcommercegetBffEcommerceViesDetail

Parameters

2 query

Query parameters

· 2

vatIdstringRequired

EU VAT identifier including country prefix (e.g., "SK2020317068").

ExampleSK2020317068

forcestringOptional

Set to "true" to bypass the 4-week cache and re-query VIES.

Exampleexample_force

Response schema

1 status code documented

200Success

vatIdstringRequired

The VAT ID that was queried.

isValidbooleanRequired

True if VIES confirmed the VAT identifier.

countryCodestringRequired

ISO 3166-1 alpha-2 country code (or "EL" for Greece in VIES).

vatNumberstringRequired

VAT identifier without the country prefix.

namestringOptional

Registered name as held by the member state.

addressstringOptional

Registered address (may contain newlines).

requestDatestringOptional

ISO date when VIES queried the national registry.

suggestReverseChargebooleanRequired

UI hint: true when the contact qualifies for EU intra-community supply (valid non-CZ EU VAT ID).

Response example

application/json

{
  "vatId": "example_vatId",
  "isValid": false,
  "countryCode": "example_countryCode",
  "vatNumber": "example_vatNumber",
  "name": "example_name",
  "address": "example_address",
  "requestDate": "example_requestDate",
  "suggestReverseCharge": false
}

Request example

GET /bff/ecommerce/vies/detail

get

curl -X GET "https://api.bizkithub.com/bff/ecommerce/vies/detail?vatId=SK2020317068&force=example_force" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key