abstract-api/json-schema/vat-validation-vat-validation-response-schema.json at main · api-evangelist/abstract-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/abstract-api/refs/heads/main/json-schema/vat-validation-vat-validation-response-schema.json",
  "title": "VATValidationResponse",
  "description": "VATValidationResponse schema from Abstract API vat-validation",
  "type": "object",
  "properties": {
    "vat_number": {
      "type": "string",
      "description": "The VAT number validated",
      "example": "GB123456789"
    },
    "valid": {
      "type": "boolean",
      "description": "Whether the VAT number is valid",
      "example": true
    },
    "company": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Company name associated with the VAT number",
          "example": "Example Ltd"
        },
        "address": {
          "type": "string",
          "description": "Company address",
          "example": "1 Example Street, London, UK"
        }
      }
    },
    "country": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Country code",
          "example": "GB"
        },
        "name": {
          "type": "string",
          "description": "Country name",
          "example": "United Kingdom"
        }
      }
    }
  }
}