{
  "openapi": "3.0.1",
  "info": {
    "title": "DS-AddressValidationInternational",
    "version": "v4",
    "description": "Documentation for DS-AddressValidationInternational-v4"
  },
  "servers": [
    {
      "url": "https://api-sandbox.postnl.nl/",
      "description": "Non-Production server"
    },
    {
      "url": "https://api.postnl.nl/",
      "description": "Production server"
    }
  ],
  "security": [
    {
      "apikey": []
    }
  ],
  "paths": {
    "/v4/address/international": {
      "get": {
        "parameters" : [ 
          {
            "name" : "houseNumber",
            "in" : "query",
            "required" : true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name" : "postalCode",
            "in" : "query",
            "required" : true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name" : "countryIso",
            "in" : "query",
            "required" : false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Succesful response"
          },
          "401": {
            "description": "Invalid apikey",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DS-AddressValidationInternationalUnauthorized"
                }
              }
            }
          },
          "405": {
            "description": "Method not allowed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DS-AddressValidationInternationalMethodNotAllowed"
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DS-AddressValidationInternationalTooManyRequest"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DS-AddressValidationInternationalUnauthorized": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Failed to resolve API Key variable 'request.header.apikey'"
          },
          "http_status_code": {
            "type": "number",
            "example": 401
          }
        }
      },
      "DS-AddressValidationInternationalMethodNotAllowed": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Only GET requests allowed"
          },
          "http_status_code": {
            "type": "number",
            "example": 405
          }
        }
      },
      "DS-AddressValidationInternationalTooManyRequest": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Too many requests. Rate limit exceeded!"
          },
          "http_status_code": {
            "type": "number",
            "example": 429
          }
        }
      }
    },
    "securitySchemes": {
      "apikey": {
        "type": "apiKey",
        "name": "apikey",
        "in": "header"
      }
    }
  }
}