> For the complete documentation index, see [llms.txt](https://docs.transactionlink.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.transactionlink.io/docs/v1/integrations/vies-vat-validation.md).

# VIES (Vat Validation)

### What kind of data I will get

The VIES VAT Number Validation API offers a straightforward yet essential set of data aimed at confirming the validity of VAT numbers within the European Union

### Input

| Attribute   | Type   | Description                                                      |
| ----------- | ------ | ---------------------------------------------------------------- |
| vatNumber   | String | Vat number to validate                                           |
| countryCode | String | Country code of validated entity in ISO 3166 format e.g.: PL, DE |

### Input Example

```
{
    "vatNumber": "123456",
    "countryCode": "PL"
}
```

### Output

### Vat Validation

| Attribute                            | Type    | Description                                       |
| ------------------------------------ | ------- | ------------------------------------------------- |
| isValid                              | Boolean | Indicates if the VAT number is valid.             |
| userError                            | String  | Error message in case of incorrect VAT number.    |
| name                                 | String  | Name of the company.                              |
| address                              | String  | Address of the company.                           |
| requestIdentifier                    | String  | Unique identifier for the request.                |
| originalVatNumber                    | String  | Original VAT number provided in the request.      |
| vatNumber                            | String  | Processed VAT number.                             |
| requestDate                          | String  | Date of the request.                              |
| [viesApproximate](#vies-approximate) | Object  | Nested object containing approximate VAT details. |

### Vies Approximate

| Attribute        | Type   | Description                             |
| ---------------- | ------ | --------------------------------------- |
| name             | String | Approximate name of the company.        |
| street           | String | Approximate street of the company.      |
| postalCode       | String | Approximate postal code of the company. |
| city             | String | Approximate city of the company.        |
| companyType      | String | Approximate type of the company.        |
| matchName        | String | Matched name of the company.            |
| matchStreet      | String | Matched street of the company.          |
| matchPostalCode  | String | Matched postal code of the company.     |
| matchCity        | String | Matched city of the company.            |
| matchCompanyType | String | Matched type of the company.            |

### Output Example

```
{
  "isValid": true,
  "userError": null,
  "name": "John Doe",
  "address": "123 Main St, Anytown, Country",
  "requestIdentifier": "REQ123456789",
  "originalVatNumber": "ABC123456",
  "vatNumber": "XYZ987654",
  "requestDate": "2023-10-01T12:34:56Z",
  "viesApproximate": {
    "name": "John's Company",
    "street": "456 Elm St",
    "postalCode": "12345",
    "city": "Big City",
    "companyType": "LLC",
    "matchName": "John's Company LTD",
    "matchStreet": "789 Pine St",
    "matchPostalCode": "67890",
    "matchCity": "Another City",
    "matchCompanyType": "Corporation"
  }
}
```
