Saltar para o conteúdo principal
GET
/
v1
/
validate
Endpoint de validação de IVA
curl --request GET \
  --url https://vat.cleariflow.com/v1/validate/
{
    "company": {
        "address": "8 RUE DE LONDRES\n75009 PARIS",
        "name": "EURL GOOGLE FRANCE"
    },
    "country": {
        "code": "FR",
        "name": "France"
    },
    "valid": true,
    "vat_number": "FR64443061841"
}

​
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: 
{
    "company": {
        "address": "8 RUE DE LONDRES\n75009 PARIS",
        "name": "EURL GOOGLE FRANCE"
    },
    "country": {
        "code": "FR",
        "name": "France"
    },
    "valid": true,
    "vat_number": "FR64443061841"
}

​
Parâmetros de pedido

​
api_key
String
obrigatório
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.
​
vat_number
String
obrigatório
O número de IVA a validar.

​
Parâmetros de resposta

A resposta da API é devolvida num formato JSON universal e leve.
​
vat_number
String
O número de IVA a validar.
​
valid
Boolean
É true se o número de IVA enviado for válido.
​
company
Object
Objeto que contém informações da empresa.
​
company.name
String
O nome da empresa associada ao número de IVA.
​
company.address
String
A morada da empresa associada ao número de IVA.
​
country
Object
Objeto que contém informações do país.
​
country.code
String
O código ISO 3166-1 alpha-2 de duas letras do país associado ao número de IVA.
​
country.name
String
O nome do país associado ao número de IVA.