> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoint de validação de IVA

> O endpoint `validate` processa números de IVA, verifica a sua autenticidade e devolve informações abrangentes da empresa, incluindo detalhes da firma, morada e registo no país.

## Primeiros passos

### URL base

```
https://vat.cleariflow.com/v1/validate/
```

### Endpoint de validação

O endpoint `validate` requer a sua chave API única e o número de IVA que pretende verificar:

```
https://vat.cleariflow.com/v1/validate/
? api_key = YOUR_UNIQUE_API_KEY
& vat_number = FR64443061841
```

Este pedido bem-sucedido devolve informações abrangentes da empresa associadas ao número de IVA validado:

<ResponseExample>
  ```json theme={"system"}
  {
      "company": {
          "address": "8 RUE DE LONDRES\n75009 PARIS",
          "name": "EURL GOOGLE FRANCE"
      },
      "country": {
          "code": "FR",
          "name": "France"
      },
      "valid": true,
      "vat_number": "FR64443061841"
  }
  ```
</ResponseExample>

### Parâmetros de pedido

<ParamField query="api_key" type="String" required>
  A sua chave API única. Note que cada utilizador tem chaves API únicas para cada API Cleariflow — a sua chave da API de validação de IVA e taxas não funcionará para a API de geolocalização IP, por exemplo.
</ParamField>

<ParamField query="vat_number" type="String" required>
  O número de IVA a validar.
</ParamField>

### Parâmetros de resposta

A resposta da API é devolvida num [formato JSON](https://www.json.org/json-en.html) universal e leve.

<ResponseField name="vat_number" type="String">
  O número de IVA a validar.
</ResponseField>

<ResponseField name="valid" type="Boolean">
  É `true` se o número de IVA enviado for válido.
</ResponseField>

<ResponseField name="company" type="Object">
  Objeto que contém informações da empresa.
</ResponseField>

<ResponseField name="company.name" type="String">
  O nome da empresa associada ao número de IVA.
</ResponseField>

<ResponseField name="company.address" type="String">
  A morada da empresa associada ao número de IVA.
</ResponseField>

<ResponseField name="country" type="Object">
  Objeto que contém informações do país.
</ResponseField>

<ResponseField name="country.code" type="String">
  O código ISO 3166-1 alpha-2 de duas letras do país associado ao número de IVA.
</ResponseField>

<ResponseField name="country.name" type="String">
  O nome do país associado ao número de IVA.
</ResponseField>