vatNumberCheck
Whether a VAT number is registered, checked live against the EU's VIES service. VIES covers the member states' VAT numbers, so another country answers UNKNOWN.
The number may carry its country prefix, spaces or dots; the country argument says which register to ask.
Arguments
| Argument | Type | Description |
|---|---|---|
country | CountryCode! | |
vatNumber | String! |
Returns
| Field | Type | Description |
|---|---|---|
status | VatNumberStatusType! | Whether the number is registered, or that this could not be told. |
name | String | The registered company name, when the register gives one. Only set when the status is VALID. |
address | String | The registered company address as one text, when the register gives one. Only set when the status is VALID. |
Example
query VatNumberCheck($country: CountryCode!, $vatNumber: String!) { vatNumberCheck(country: $country, vatNumber: $vatNumber) { status name address }}{ "country": "NL", "vatNumber": "Example"}{ "data": { "vatNumberCheck": { "status": "VALID", "name": "Example", "address": "Example" } }}The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.
Used by
The storefront packages that send it, in these GraphQL documents:
- @evolve-storefront/feature-cart:
CheckVatNumber

