Search Response Schema

VAT_VALIDATE Response Schema

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "object",
                  "properties": {
                     "vat_number": {
                        "type": "string"
                     },
                     "valid": {
                        "type": "boolean"
                     },
                     "company": {
                        "type": "object",
                        "properties": {
                           "name": {
                              "type": "string"
                           },
                           "address": {
                              "type": "string"
                           }
                        },
                        "required": [
                           "address",
                           "name"
                        ]
                     },
                     "country": {
                        "type": "object",
                        "properties": {
                           "code": {
                              "type": "string"
                           },
                           "name": {
                              "type": "string"
                           }
                        },
                        "required": [
                           "code",
                           "name"
                        ]
                     }
                  },
                  "required": [
                     "company",
                     "country",
                     "valid",
                     "vat_number"
                  ]
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}

IBAN Response Schema

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "object",
                  "properties": {
                     "iban": {
                        "type": "string"
                     },
                     "is_valid": {
                        "type": "boolean"
                     }
                  },
                  "required": [
                     "iban",
                     "is_valid"
                  ]
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}

COMPANY_ENRICH Response Schema

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "object",
                  "properties": {
                     "name": {
                        "type": "string"
                     },
                     "domain": {
                        "type": "string"
                     },
                     "year_founded": {
                        "type": "integer"
                     },
                     "industry": {
                        "type": "string"
                     },
                     "employees_count": {
                        "type": "integer"
                     },
                     "locality": {
                        "type": "string"
                     },
                     "country": {
                        "type": "string"
                     },
                     "linkedin_url": {
                        "type": "string"
                     }
                  },
                  "required": [
                     "country",
                     "domain",
                     "employees_count",
                     "industry",
                     "linkedin_url",
                     "locality",
                     "name",
                     "year_founded"
                  ]
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}

Last updated