Cloudmersive Vat API

openapi: 3.2.0
info:
  version: v1
  title: validateapi Vat API
  description: The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
servers:
- url: http://localhost
tags:
- name: Vat
paths:
  /validate/vat/lookup:
    post:
      tags:
      - Vat
      summary: Validate a VAT number
      description: Checks if a VAT code is valid, and if it is, returns more information about it. The first two letters of the VAT number must be letters that indicate the country, such as LU20260743. Possible country codes include Austria (AT), Belgium (BE), Bulgaria (BG), Cyprus (CY), Czech Republic (CZ), Germany (DE), Denmark (DK), Estonia (EE), Greece (EL), Spain (ES), Finland (FI), France (FR), United Kingdom (GB), Croatia (HR), Hungary (HU), Ireland (IE), Italy (IT), Lithuania (LT), Luxembourg (LU), Latvia (LV), Malta (MT), The Netherlands (NL), Poland (PL), Portugal (PT), Romania (RO), Sweden (SE), Slovenia (SI), Slovakia (SK).
      operationId: Vat_VatLookup
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VatLookupResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/VatLookupResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/VatLookupResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/VatLookupResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VatLookupRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/VatLookupRequest'
        description: Input VAT code
        required: true
components:
  schemas:
    VatLookupResponse:
      type: object
      properties:
        CountryCode:
          description: Two-letter country code
          type: string
        VatNumber:
          description: VAT number
          type: string
        IsValid:
          description: True if the VAT code is valid, false otherwise
          type: boolean
        BusinessName:
          description: Name of the business
          type: string
        BusinessAddress:
          description: Business address as a single string
          type: string
        BusinessBuilding:
          description: For the business address, the name of the building, house or structure if applicable, such as "Cloudmersive Building 2".  This will often by null.
          type: string
        BusinessStreetNumber:
          description: For the business address, the street number or house number of the address.  For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "1600".  This value will typically be populated for most addresses.
          type: string
        BusinessStreet:
          description: For the business address, the name of the street or road of the address.  For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "Pennsylvania Avenue NW".
          type: string
        BusinessCity:
          description: For the business address, the city of the address.
          type: string
        BusinessStateOrProvince:
          description: For the business address, the state or province of the address.
          type: string
        BusinessPostalCode:
          description: For the business address, the postal code or zip code of the address.
          type: string
        BusinessCountry:
          description: For the business address, country of the address, if present in the address.  If not included in the address it will be null.
          type: string
    VatLookupRequest:
      description: Input to a VAT lookup request
      type: object
      properties:
        VatCode:
          description: VAT code to lookup; example "CZ25123891"
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/validate/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)