apitier-validate-vat-api-1.0.0.yaml

openapi: 3.0.1
info:
  title: Validate VAT Number API
  description: These are API Tier API's to expedite your development, enrich the user experience.
  contact:
    email: hello@apitier.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/apitier/test1/1.0.0
- url:  https://vat.apitier.com/v1
tags:
- name: Validate VAT Number API
  description: APIs to help you build day-to-day VAT validation.
paths:
  /validate:
    get:
      tags:
      - Validate VAT Number API
      summary: Validate VAT
      description: |
        Validates Given VAT Number
      parameters:
      - name: vat_number
        in: query
        description: VAT Number for validation
        required: true
        schema:
          type: string
        examples:       
          single:         
            value: IE6388047V    
            summary: VAT number 
      - name: x-api-key
        in: query
        description: Unique API key generated to access API.
        required: true
        schema:
          type: string
        examples:       
          single:         
            value: api_key   
            summary: API Key value
      responses:
        200:
          description: addresses results for given postcode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateVATItem'
              examples:   
                Single:   # Example 1
                  value:
                    status: 200
                    message: Success
                    result:
                      vatNumber: IE6388047V
                      isValid: true
                      company:
                        name: GOOGLE IRELAND LIMITED
                        address: GOOGLE IRLAND LTD , M COLLINS, GORDON HOUSE , BARROW STREET, DUBLIN 4 , IRLAND
                      country:
                        code: IE
                        name: Ireland

                InvalidVAT:   # Example 2
                  value:
                      status: 200
                      message: Success
                      result:
                        vatNumber: '556656688001111'
                        message: Validation Failed
                        reason: The provided CountryCode is invalid or the VAT number is empty

        400:
          description: Bad Request - Request failed due to invalid syntax
          content: {}
        401:
          description: Unauthorized - Client must authenticate itself to get the requested
            response
          content: {}
        402:
          description: Payment Required - Request Failed as request credit not avaialble.
          content: {}
        403:
          description: Forbidden - Provided API key is not known to the server.
          content: {}
        404:
          description: Resource Not Found - The server can not find the requested
            resource.
          content: {}
        429:
          description: Too Many Requests - The user has sent too many requests in
            a given amount of time ("rate limiting").
          content: {}
        500:
          description: Internal Server Error - The server has error to handle request.
          content: {}
components:
  schemas:
    ValidateVATItem:
      type: object
      properties:
        status:
          type: integer
          format: int32
          example: 200
        message:
          type: string
          example: Success
        result:
          type: object
          properties:
            vatNumber:
              type: string
              example: IE6388047V
            isValid:
              type: boolean
              example: true
            country:
              $ref: '#/components/schemas/country'
            company:
              $ref: '#/components/schemas/company'
    country:
      type: object
      properties:
        name:
          type: string
          example: Sweden
        code:
          type: string
          example: SE
    company:
      type: object
      properties:
        name:
          type: string
          example: 'GOOGLE IRELAND LIMITED'
        address:
          type: string
          example: 'GOOGLE IRLAND LTD , M COLLINS, GORDON HOUSE , BARROW STREET, DUBLIN 4 , IRLAND'
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
          example: 400
        message:
          type: string
          example: Error Message