openapi: 3.0.3
info:
  title: Matrixian API
  version: 0.0.1
servers:
- url: https://api.matrixian.com/v1
  description: Matrixian API
paths:
  /address-suggestion:
    get:
      description: Autocomplete with suggested addresses. Response includes additional
        object information.
      operationId: addressSuggestion
      parameters:
      - description: Raw query string representing an address line
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: Graafland 22, 1251NJ Laren
        name: q
        in: query
      responses:
        '200':
          description: AddressSuggestionResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          q: Graafland 22, 1251NJ Laren
                        nullable: true
                      data:
                        $ref: '#/components/schemas/AddressSuggestionResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          q: Graafland 22, 1251NJ Laren
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          q: Graafland 22, 1251NJ Laren
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          q: Graafland 22, 1251NJ Laren
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          q: Graafland 22, 1251NJ Laren
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          q: Graafland 22, 1251NJ Laren
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        q: Graafland 22, 1251NJ Laren
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /bag-data:
    get:
      description: Returns data from the Basic Registration of Addresses and Buildings
        (BAG) after entering the postal code and house number.
      operationId: bagData
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: BagDataResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/BagDataResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /cadastral-objects:
    get:
      description: Returns a list of cadastral plot Ids.
      operationId: cadastralObjects
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: CadastralObjectsResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/CadastralObjectsResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /cadastral-ownership:
    get:
      description: Returns data included in the title deed for the inputted parcel.
      operationId: cadastralOwnership
      parameters:
      - description: Parcel ID
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: LRN01-G-1396
        name: parcel_id
        in: query
      - description: Whether to return a jpeg instead of a pdf.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
        name: jpeg
        in: query
      responses:
        '200':
          description: CadastralOwnershipResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          parcel_id: LRN01-G-1396
                          jpeg: 'False'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/CadastralOwnershipResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          parcel_id: LRN01-G-1396
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          parcel_id: LRN01-G-1396
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          parcel_id: LRN01-G-1396
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          parcel_id: LRN01-G-1396
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          parcel_id: LRN01-G-1396
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        parcel_id: LRN01-G-1396
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /certificate-of-ownership:
    get:
      description: Returns the certificate of ownership for a parcel.
      operationId: certificateOfOwnership
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Whether to return a jpeg instead of a pdf.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
        name: jpeg
        in: query
      responses:
        '200':
          description: CertificateOfOwnershipResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          jpeg: 'False'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/CertificateOfOwnershipResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          jpeg: 'False'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        jpeg: 'False'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /commercial-transactions:
    get:
      description: Retrieves commercial transactions for an object.
      operationId: commercialTransactions
      parameters:
      - description: Zipcode
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Identification number according to the BAG.
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: bagNummeraanduidingid
        in: query
      - description: Identification number of the building according to the BAG.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '100001892532'
        name: pandId
        in: query
      - description: Over stuk
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: NL4  8577500053
        name: overStuk
        in: query
      responses:
        '200':
          description: CommercialTransactionsResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          pandId: '100001892532'
                          overStuk: NL4  8577500053
                        nullable: true
                      data:
                        $ref: '#/components/schemas/CommercialTransactionsResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          pandId: '100001892532'
                          overStuk: NL4  8577500053
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          pandId: '100001892532'
                          overStuk: NL4  8577500053
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          pandId: '100001892532'
                          overStuk: NL4  8577500053
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          pandId: '100001892532'
                          overStuk: NL4  8577500053
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          pandId: '100001892532'
                          overStuk: NL4  8577500053
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        pandId: '100001892532'
                        overStuk: NL4  8577500053
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /homevalue:
    get:
      description: Returns the predicted market value and related information.
      operationId: homevalue
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postal_code
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Type of dwelling
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: type
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: year
        in: query
      - description: The usable surface area of a property object in m2.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: use_surface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: Number of rooms.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 5
        name: rooms
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Boolean indicating whether the house is a monument.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
        name: monument
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: date
        in: query
      - description: Minimal accuracy score
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minAccuracy
        in: query
      responses:
        '200':
          description: HomevalueResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/HomevalueResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /homevalue/available:
    get:
      description: Checks if an object is suitable for market value prediction.
      operationId: homevalueAvailable
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postal_code
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Type of dwelling
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: type
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: year
        in: query
      - description: The usable surface area of a property object in m2.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: use_surface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: Number of rooms.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 5
        name: rooms
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Boolean indicating whether the house is a monument.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
        name: monument
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: date
        in: query
      - description: Minimal accuracy score
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minAccuracy
        in: query
      responses:
        '200':
          description: HomevalueAvailableResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/HomevalueAvailableResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /homevalue/value:
    get:
      description: Returns the market value prediction.
      operationId: homevalueValue
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postal_code
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Type of dwelling
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: type
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: year
        in: query
      - description: The usable surface area of a property object in m2.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: use_surface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: Number of rooms.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 5
        name: rooms
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Boolean indicating whether the house is a monument.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
        name: monument
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: date
        in: query
      - description: Minimal accuracy score
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minAccuracy
        in: query
      responses:
        '200':
          description: HomevalueValueResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/HomevalueValueResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          year: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        year: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /leadtool:
    get:
      description: Offer a free home valuation report to website visitors.
      operationId: leadtool
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postal_code
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Type of dwelling
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: type
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: buildYear
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: use_surface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: Number of rooms.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 5
        name: rooms
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Boolean indicating whether the house is a monument.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
        name: monument
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: date
        in: query
      - description: Minimal accuracy score
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minAccuracy
        in: query
      responses:
        '200':
          description: LeadtoolResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          buildYear: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/LeadtoolResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          buildYear: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          buildYear: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          buildYear: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          buildYear: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          houseNumber: '22'
                          type: 2-onder-1-kapwoning
                          buildYear: '1955'
                          use_surface: '104'
                          parcelSurface: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          date: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        houseNumber: '22'
                        type: 2-onder-1-kapwoning
                        buildYear: '1955'
                        use_surface: '104'
                        parcelSurface: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        date: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-house-and-hood:
    get:
      description: Returns information on the property object and its neighborhood.
      operationId: houseAndHood
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: HouseAndHoodResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/HouseAndHoodResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-house-details:
    get:
      description: Returns detailed property data for an address.
      operationId: HouseDetails
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: HouseDetailsResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/HouseDetailsResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-house-images:
    get:
      description: Returns photos of a property object.
      operationId: HouseImages
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: HouseImagesResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/HouseImagesResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-transaction-finder:
    get:
      description: Returns a list of reference objects and their transaction prices.
      operationId: transactionFinder
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: valuationDate
        in: query
      - description: The acceptance date is the date on which you, as a buyer, become
          the owner of the house.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: dateTransport
        in: query
      responses:
        '200':
          description: TransactionFinderResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/TransactionFinderResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-reference-finder:
    get:
      description: Returns comparable properties with price ranges.
      operationId: mxReferenceFinder
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: valuationDate
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: buildYear
        in: query
      - description: Type of dwelling.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: houseType
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: useSurface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Allowed house types of reference objects, separated by commas.
        required: false
        style: form
        explode: false
        schema:
          items:
            type: string
            enum:
            - Appartement
            - Galerijflat
            - Maisonnette
            - Portiekwoning
            - Portiekflat
            - Corridorflat
            - Bovenwoning
            - Benedenwoning
            - Tussenwoning
            - Geschakelde woning
            - Eindwoning
            - Hoekwoning
            - 2-onder-1-kapwoning
            - Geschakelde 2-onder-1-kapwoning
            - Halfvrijstaande woning
            - Vrijstaande woning
          type: array
          uniqueItems: true
          example:
          - Appartement
          - 2-onder-1-kapwoning
        name: allowedHouseTypes
        in: query
      - description: Measure of Location importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: locationWeight
        in: query
      - description: Measure of House details importance in finding WOZ reference
          objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: houseDetailsWeight
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Amount of reference objects to return.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 50
          example: 50
        name: nReferences
        in: query
      - description: Minimal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minUseSurface
        in: query
      - description: Maximal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 200
        name: maxUseSurface
        in: query
      - description: Minimum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2020
        name: minBuildYear
        in: query
      - description: Maximum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2025
        name: maxBuildYear
        in: query
      - description: Minimal parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minParcelSurface
        in: query
      - description: Maximum parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 400
        name: maxParcelSurface
        in: query
      - description: Maximum distance from the valuation object to the reference object
          in meters.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10000
        name: maxDistance
        in: query
      - description: Minimal transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: minTransportDate
        in: query
      - description: Maximum  transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: maxTransportDate
        in: query
      - description: Measure of transport date importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.2
          example: 0.2
        name: transportDateWeight
        in: query
      responses:
        '200':
          description: MxReferenceFinderResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/MxReferenceFinderResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-reference-finder/available:
    get:
      description: Checks if an object has comparable references available.
      operationId: mxReferenceFinderAvailable
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: valuationDate
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: buildYear
        in: query
      - description: Type of dwelling.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: houseType
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: useSurface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Allowed house types of reference objects, separated by commas.
        required: false
        style: form
        explode: false
        schema:
          items:
            type: string
            enum:
            - Appartement
            - Galerijflat
            - Maisonnette
            - Portiekwoning
            - Portiekflat
            - Corridorflat
            - Bovenwoning
            - Benedenwoning
            - Tussenwoning
            - Geschakelde woning
            - Eindwoning
            - Hoekwoning
            - 2-onder-1-kapwoning
            - Geschakelde 2-onder-1-kapwoning
            - Halfvrijstaande woning
            - Vrijstaande woning
          type: array
          uniqueItems: true
          example:
          - Appartement
          - 2-onder-1-kapwoning
        name: allowedHouseTypes
        in: query
      - description: Measure of Location importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: locationWeight
        in: query
      - description: Measure of House details importance in finding WOZ reference
          objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: houseDetailsWeight
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Amount of reference objects to return.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 50
          example: 50
        name: nReferences
        in: query
      - description: Minimal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minUseSurface
        in: query
      - description: Maximal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 200
        name: maxUseSurface
        in: query
      - description: Minimum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2020
        name: minBuildYear
        in: query
      - description: Maximum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2025
        name: maxBuildYear
        in: query
      - description: Minimal parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minParcelSurface
        in: query
      - description: Maximum parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 400
        name: maxParcelSurface
        in: query
      - description: Maximum distance from the valuation object to the reference object
          in meters.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10000
        name: maxDistance
        in: query
      - description: Minimal transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: minTransportDate
        in: query
      - description: Maximum  transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: maxTransportDate
        in: query
      - description: Measure of transport date importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.2
          example: 0.2
        name: transportDateWeight
        in: query
      responses:
        '200':
          description: MxReferenceFinderAvailableResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/MxReferenceFinderAvailableResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          nReferences: '50'
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        nReferences: '50'
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-transactions:
    get:
      description: Returns historical transactions for the inputted property object.
      operationId: transactions
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: MxTransactionsResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/MxTransactionsResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx-woz-reference-finder:
    get:
      description: Returns comparable properties for WOZ characteristics.
      operationId: wozReferenceFinder
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: valuationDate
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: buildYear
        in: query
      - description: Type of dwelling.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: houseType
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: useSurface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Allowed house types of reference objects, separated by commas.
        required: false
        style: form
        explode: false
        schema:
          items:
            type: string
            enum:
            - Appartement
            - Galerijflat
            - Maisonnette
            - Portiekwoning
            - Portiekflat
            - Corridorflat
            - Bovenwoning
            - Benedenwoning
            - Tussenwoning
            - Geschakelde woning
            - Eindwoning
            - Hoekwoning
            - 2-onder-1-kapwoning
            - Geschakelde 2-onder-1-kapwoning
            - Halfvrijstaande woning
            - Vrijstaande woning
          type: array
          uniqueItems: true
          example:
          - Appartement
          - 2-onder-1-kapwoning
        name: allowedHouseTypes
        in: query
      - description: Measure of Location importance in finding WOZ reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.5
          example: 0.5
        name: locationWeight
        in: query
      - description: Measure of House details importance in finding WOZ reference
          objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.5
          example: 0.5
        name: houseDetailsWeight
        in: query
      - description: Fiscal year
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 2024
        name: fiscalYear
        in: query
      - description: Maximum difference between build year and reference object build
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 1
        name: maxBuildYearDiff
        in: query
      - description: Maximum percentage difference between use surface and reference
          object use surface.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.1
          example: 0.1
        name: maxUseSurfacePctDiff
        in: query
      - description: Maximum percentage difference between parcel surface and reference
          object parcel surface.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.2
          example: 0.2
        name: maxParcelSurfacePctDiff
        in: query
      responses:
        '200':
          description: WozReferenceFinderResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.5'
                          houseDetailsWeight: '0.5'
                          fiscalYear: '2024'
                          maxBuildYearDiff: '1'
                          maxUseSurfacePctDiff: '0.1'
                          maxParcelSurfacePctDiff: '0.2'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/WozReferenceFinderResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.5'
                          houseDetailsWeight: '0.5'
                          fiscalYear: '2024'
                          maxBuildYearDiff: '1'
                          maxUseSurfacePctDiff: '0.1'
                          maxParcelSurfacePctDiff: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.5'
                          houseDetailsWeight: '0.5'
                          fiscalYear: '2024'
                          maxBuildYearDiff: '1'
                          maxUseSurfacePctDiff: '0.1'
                          maxParcelSurfacePctDiff: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.5'
                          houseDetailsWeight: '0.5'
                          fiscalYear: '2024'
                          maxBuildYearDiff: '1'
                          maxUseSurfacePctDiff: '0.1'
                          maxParcelSurfacePctDiff: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.5'
                          houseDetailsWeight: '0.5'
                          fiscalYear: '2024'
                          maxBuildYearDiff: '1'
                          maxUseSurfacePctDiff: '0.1'
                          maxParcelSurfacePctDiff: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.5'
                          houseDetailsWeight: '0.5'
                          fiscalYear: '2024'
                          maxBuildYearDiff: '1'
                          maxUseSurfacePctDiff: '0.1'
                          maxParcelSurfacePctDiff: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.5'
                        houseDetailsWeight: '0.5'
                        fiscalYear: '2024'
                        maxBuildYearDiff: '1'
                        maxUseSurfacePctDiff: '0.1'
                        maxParcelSurfacePctDiff: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx10-reference-finder:
    get:
      description: Retrieves 10 references for an object.
      operationId: mx10ReferenceFinder
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: valuationDate
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: buildYear
        in: query
      - description: Type of dwelling.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: houseType
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: useSurface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Allowed house types of reference objects, separated by commas.
        required: false
        style: form
        explode: false
        schema:
          items:
            type: string
            enum:
            - Appartement
            - Galerijflat
            - Maisonnette
            - Portiekwoning
            - Portiekflat
            - Corridorflat
            - Bovenwoning
            - Benedenwoning
            - Tussenwoning
            - Geschakelde woning
            - Eindwoning
            - Hoekwoning
            - 2-onder-1-kapwoning
            - Geschakelde 2-onder-1-kapwoning
            - Halfvrijstaande woning
            - Vrijstaande woning
          type: array
          uniqueItems: true
          example:
          - Appartement
          - 2-onder-1-kapwoning
        name: allowedHouseTypes
        in: query
      - description: Measure of Location importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: locationWeight
        in: query
      - description: Measure of House details importance in finding WOZ reference
          objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: houseDetailsWeight
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Minimal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minUseSurface
        in: query
      - description: Maximal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 200
        name: maxUseSurface
        in: query
      - description: Minimum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2020
        name: minBuildYear
        in: query
      - description: Maximum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2025
        name: maxBuildYear
        in: query
      - description: Minimal parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minParcelSurface
        in: query
      - description: Maximum parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 400
        name: maxParcelSurface
        in: query
      - description: Maximum distance from the valuation object to the reference object
          in meters.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10000
        name: maxDistance
        in: query
      - description: Minimal transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: minTransportDate
        in: query
      - description: Maximum  transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: maxTransportDate
        in: query
      - description: Measure of transport date importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.2
          example: 0.2
        name: transportDateWeight
        in: query
      responses:
        '200':
          description: MxReferenceFinderResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/MxReferenceFinderResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /mx20-reference-finder:
    get:
      description: Retrieves 20 references for an object.
      operationId: mx20ReferenceFinder
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      - description: Valuation date
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
          default: '2025-11-10'
          example: '2025-11-10'
        name: valuationDate
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: buildYear
        in: query
      - description: Type of dwelling.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: houseType
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: useSurface
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: parcelSurface
        in: query
      - description: Allowed house types of reference objects, separated by commas.
        required: false
        style: form
        explode: false
        schema:
          items:
            type: string
            enum:
            - Appartement
            - Galerijflat
            - Maisonnette
            - Portiekwoning
            - Portiekflat
            - Corridorflat
            - Bovenwoning
            - Benedenwoning
            - Tussenwoning
            - Geschakelde woning
            - Eindwoning
            - Hoekwoning
            - 2-onder-1-kapwoning
            - Geschakelde 2-onder-1-kapwoning
            - Halfvrijstaande woning
            - Vrijstaande woning
          type: array
          uniqueItems: true
          example:
          - Appartement
          - 2-onder-1-kapwoning
        name: allowedHouseTypes
        in: query
      - description: Measure of Location importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: locationWeight
        in: query
      - description: Measure of House details importance in finding WOZ reference
          objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.4
          example: 0.4
        name: houseDetailsWeight
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Minimal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minUseSurface
        in: query
      - description: Maximal use surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 200
        name: maxUseSurface
        in: query
      - description: Minimum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2020
        name: minBuildYear
        in: query
      - description: Maximum build year of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 2025
        name: maxBuildYear
        in: query
      - description: Minimal parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 100
        name: minParcelSurface
        in: query
      - description: Maximum parcel surface of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 400
        name: maxParcelSurface
        in: query
      - description: Maximum distance from the valuation object to the reference object
          in meters.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10000
        name: maxDistance
        in: query
      - description: Minimal transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: minTransportDate
        in: query
      - description: Maximum  transport date of reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
        name: maxTransportDate
        in: query
      - description: Measure of transport date importance in finding reference objects.
        required: false
        style: form
        explode: true
        schema:
          type: number
          default: 0.2
          example: 0.2
        name: transportDateWeight
        in: query
      responses:
        '200':
          description: MxReferenceFinderResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/MxReferenceFinderResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                          valuationDate: '2025-11-10'
                          buildYear: '1955'
                          houseType: 2-onder-1-kapwoning
                          useSurface: '104'
                          parcelSurface: '338'
                          allowedHouseTypes: Appartement,2-onder-1-kapwoning
                          locationWeight: '0.4'
                          houseDetailsWeight: '0.4'
                          volume: '411'
                          energyLabel: E
                          minUseSurface: '100'
                          maxUseSurface: '200'
                          minBuildYear: '2020'
                          maxBuildYear: '2025'
                          minParcelSurface: '100'
                          maxParcelSurface: '400'
                          maxDistance: '10000'
                          transportDateWeight: '0.2'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                        valuationDate: '2025-11-10'
                        buildYear: '1955'
                        houseType: 2-onder-1-kapwoning
                        useSurface: '104'
                        parcelSurface: '338'
                        allowedHouseTypes: Appartement,2-onder-1-kapwoning
                        locationWeight: '0.4'
                        houseDetailsWeight: '0.4'
                        volume: '411'
                        energyLabel: E
                        minUseSurface: '100'
                        maxUseSurface: '200'
                        minBuildYear: '2020'
                        maxBuildYear: '2025'
                        minParcelSurface: '100'
                        maxParcelSurface: '400'
                        maxDistance: '10000'
                        transportDateWeight: '0.2'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /modelwaarde:
    get:
      description: Returns the current modeled property value and related info.
      operationId: modelwaarde
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postal_code
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: huisnummer
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: huisletter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: huisnummertoevoeging
        in: query
      - description: Type of dwelling
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: woningtype
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: bouwjaar
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: woonopp
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: perceelopp
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: Number of rooms.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 5
        name: rooms
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Boolean indicating whether the house is a monument.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
        name: monument
        in: query
      - description: Valuation date
        required: true
        style: form
        explode: true
        schema:
          type: string
          format: date
          example: '2025-11-10'
        name: peildatum
        in: query
      - description: Minimal accuracy score
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minnauwkeurigheidsindicator
        in: query
      - description: Identification number according to the BAG.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 0417200000001419
        name: bagnummeraanduidingid
        in: query
      - description: Minimum value
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minmodelwaarde
        in: query
      - description: Maximum value
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: maxmodelwaarde
        in: query
      - description: Request type, standaard/aanvullend
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - standaard
          - aanvullend
          example: standaard
        name: type
        in: query
      responses:
        '200':
          description: ModelwaardeResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        $ref: '#/components/schemas/ModelwaardeResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /modelwaarde/beschikbaar:
    get:
      description: Checks if a property object is suitable for market value prediction.
      operationId: modelwaardeBeschikbaar
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postal_code
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: huisnummer
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: huisletter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: huisnummertoevoeging
        in: query
      - description: Type of dwelling
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - Appartement
          - Galerijflat
          - Maisonnette
          - Portiekwoning
          - Portiekflat
          - Corridorflat
          - Bovenwoning
          - Benedenwoning
          - Tussenwoning
          - Geschakelde woning
          - Eindwoning
          - Hoekwoning
          - 2-onder-1-kapwoning
          - Geschakelde 2-onder-1-kapwoning
          - Halfvrijstaande woning
          - Vrijstaande woning
          example: 2-onder-1-kapwoning
        name: woningtype
        in: query
      - description: Indication of the year in which the building will originally
          be delivered in, or is architectually ready. Also known as construction
          year.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 1955
        name: bouwjaar
        in: query
      - description: The usable surface area of a property object in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 104
        name: woonopp
        in: query
      - description: The lot/parcel surface in m2.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 338
        name: perceelopp
        in: query
      - description: Volume in m3.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 411
        name: volume
        in: query
      - description: Number of rooms.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          example: 5
        name: rooms
        in: query
      - description: A label indicating how well the property object is insulated.
        required: false
        style: form
        explode: true
        schema:
          type: string
          enum:
          - A+++++
          - A++++
          - A+++
          - A++
          - A+
          - A
          - B
          - C
          - D
          - E
          - F
          - G
          example: E
        name: energyLabel
        in: query
      - description: Boolean indicating whether the house is a monument.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
          example: false
        name: monument
        in: query
      - description: Valuation date
        required: true
        style: form
        explode: true
        schema:
          type: string
          format: date
          example: '2025-11-10'
        name: peildatum
        in: query
      - description: Minimal accuracy score
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minnauwkeurigheidsindicator
        in: query
      - description: Identification number according to the BAG.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 0417200000001419
        name: bagnummeraanduidingid
        in: query
      - description: Minimum value
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: minmodelwaarde
        in: query
      - description: Maximum value
        required: false
        style: form
        explode: true
        schema:
          type: integer
        name: maxmodelwaarde
        in: query
      - description: Request type, standaard/aanvullend
        required: true
        style: form
        explode: true
        schema:
          type: string
          enum:
          - standaard
          - aanvullend
          example: standaard
        name: type
        in: query
      responses:
        '200':
          description: ModelwaardeBeschikbaarResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        $ref: '#/components/schemas/ModelwaardeBeschikbaarResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postal_code: 1251NJ
                          huisnummer: '22'
                          woningtype: 2-onder-1-kapwoning
                          bouwjaar: '1955'
                          woonopp: '104'
                          perceelopp: '338'
                          volume: '411'
                          rooms: '5'
                          energyLabel: E
                          monument: 'False'
                          peildatum: '2025-11-10'
                          bagnummeraanduidingid: 0417200000001419
                          type: standaard
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postal_code: 1251NJ
                        huisnummer: '22'
                        woningtype: 2-onder-1-kapwoning
                        bouwjaar: '1955'
                        woonopp: '104'
                        perceelopp: '338'
                        volume: '411'
                        rooms: '5'
                        energyLabel: E
                        monument: 'False'
                        peildatum: '2025-11-10'
                        bagnummeraanduidingid: 0417200000001419
                        type: standaard
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /local-tax-energy-expenses:
    get:
      description: Indicates the housing costs that apply per municipality.
      operationId: MunicipalityLivingCosts
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: LocalTaxEnergyResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/LocalTaxEnergyResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /woz-value:
    get:
      description: Returns all WOZ values from 2015 onwards.
      operationId: wozWaarden
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: WozValueResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/WozValueResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
  /woz-viability:
    get:
      description: Checks if a WOZ dispute is possible for an object.
      operationId: wozViability
      parameters:
      - description: Zipcode
        required: true
        style: form
        explode: true
        schema:
          type: string
          example: 1251NJ
        name: postalCode
        in: query
      - description: House number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          example: 22
        name: houseNumber
        in: query
      - description: House letter
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseLetter
        in: query
      - description: House number extention
        required: false
        style: form
        explode: true
        schema:
          type: string
        name: houseNumberExt
        in: query
      responses:
        '200':
          description: WozViabilityResponse
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 200
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        example: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        $ref: '#/components/schemas/WozViabilityResponse'
                      error:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: success
                    type: object
                    required:
                    - data
                    - status
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
        '400':
          description: HTTP 400
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                invalid_input_400:
                  summary: Invalid Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: this value must be of format 1234AB
                        - reason: houseNumber
                          message: this value must be a positive number
                      meta: {}
                      status: failure
                missing_input_400:
                  summary: Missing Input 400
                  value:
                    statusCode: 400
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 400
                        message: Bad Request
                        errors:
                        - reason: postalCode
                          message: Field required
                      meta: {}
                      status: failure
        '401':
          description: HTTP 401
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                unauthorized_401:
                  summary: Unauthorized 401
                  value:
                    statusCode: 401
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 401
                        message: Unauthorized
                        errors: []
                      meta: {}
                      status: failure
        '403':
          description: HTTP 403
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                no_subscription_403:
                  summary: No Subscription 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: missing_subscription
                          message: Your plan does not include access to this endpoint.
                      meta: {}
                      status: failure
                rate_limit_403:
                  summary: Rate Limit 403
                  value:
                    statusCode: 403
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 403
                        message: Forbidden
                        errors:
                        - reason: rate_limit
                          message: Rate limit exceeded. Please retry later or contact
                            support@matrixian.com.
                      meta: {}
                      status: failure
        '404':
          description: HTTP 404
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                not_found_404:
                  summary: Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: Address could not be found.
                      meta: {}
                      status: failure
                route_not_found_404:
                  summary: Route Not Found 404
                  value:
                    statusCode: 404
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 404
                        message: Not Found
                        errors:
                        - reason: Not Found
                          message: The requested route or method was not found.
                      meta: {}
                      status: failure
        '500':
          description: HTTP 500
          content:
            application/json:
              schema:
                properties:
                  statusCode:
                    type: integer
                    example: 500
                  headers:
                    additionalProperties:
                      type: string
                    type: object
                    description: HTTP headers returned by Lambda/API Gateway.
                    example:
                      Content-Type: application/json
                  isBase64Encoded:
                    type: boolean
                    example: false
                  body:
                    properties:
                      id:
                        type: string
                        nullable: true
                      params:
                        additionalProperties:
                          type: string
                        type: object
                        example:
                          postalCode: 1251NJ
                          houseNumber: '22'
                        nullable: true
                      data:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                      error:
                        $ref: '#/components/schemas/ErrorObject'
                      meta:
                        additionalProperties:
                          type: string
                        type: object
                        example: {}
                        nullable: true
                      status:
                        type: string
                        example: failure
                    type: object
                    required:
                    - error
                    - status
                    example:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
                type: object
                required:
                - statusCode
                - headers
                - isBase64Encoded
                - body
              examples:
                svc_unavailable_503:
                  summary: Svc Unavailable 503
                  value:
                    statusCode: 500
                    headers:
                      Content-Type: application/json
                    isBase64Encoded: false
                    body:
                      id: string
                      params:
                        postalCode: 1251NJ
                        houseNumber: '22'
                      data: {}
                      error:
                        code: 503
                        message: Service Unavailable
                        errors: []
                      meta: {}
                      status: failure
components:
  schemas:
    ErrorDetail:
      properties:
        reason:
          type: string
          title: Reason
        message:
          type: string
          title: Message
      type: object
      required:
      - reason
      - message
      title: ErrorDetail
    ErrorObject:
      properties:
        code:
          type: integer
          title: Code
        message:
          type: string
          title: Message
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Errors
      type: object
      required:
      - code
      - message
      - errors
      title: ErrorObject
    ErrorResponse: {}
    AddressSuggestionResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AddressSuggestionItem'
          type: array
          title: Items
      type: object
      required:
      - items
      title: AddressSuggestionResponse
    BagDataResponse:
      properties:
        building:
          description: Building
          allOf:
          - $ref: '#/components/schemas/Building'
        numberDesignation:
          description: Number designation
          allOf:
          - $ref: '#/components/schemas/NumberDesignation'
        object:
          description: Object
          allOf:
          - $ref: '#/components/schemas/Object'
        place:
          description: Place
          allOf:
          - $ref: '#/components/schemas/Place'
        publicSpace:
          description: Public space
          allOf:
          - $ref: '#/components/schemas/PublicSpace'
        sourceHolder:
          description: Source holder
          allOf:
          - $ref: '#/components/schemas/SourceHolder'
      type: object
      required:
      - building
      - numberDesignation
      - object
      - place
      - publicSpace
      - sourceHolder
      title: BagDataResponse
    CadastralObjectsResponse:
      properties:
        parcelIds:
          items:
            type: string
          type: array
          title: Parcelids
          description: Parcel ids
          example: LRN01-G-1396
      type: object
      required:
      - parcelIds
      title: CadastralObjectsResponse
    CadastralOwnershipResponse:
      properties:
        actualiteitstijdstipHypothecair:
          title: Actualiteitstijdstiphypothecair
          type: string
          nullable: true
        actualiteitstijdstipKadastraal:
          title: Actualiteitstijdstipkadastraal
          type: string
          nullable: true
        klantreferentie:
          title: klantreferentie
          type: string
          nullable: true
        productieordernummer:
          title: productieordernummer
          type: string
          nullable: true
        signaleringstijdstipBeslagen:
          title: Signaleringstijdstipbeslagen
          type: string
          nullable: true
        signaleringstijdstipHypothecair:
          title: Signaleringstijdstiphypothecair
          type: string
          nullable: true
        signaleringstijdstipKadastraal:
          title: Signaleringstijdstipkadastraal
          type: string
          nullable: true
        tijdstipSamenstellingBericht:
          title: Tijdstipsamenstellingbericht
          type: string
          nullable: true
        betreft:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        met:
          allOf:
          - $ref: '#/components/schemas/EDICollectie'
          nullable: true
        jpegsBase64:
          title: Jpegsbase64
          description: List of base64 encoded JPEG files
          example:
          - JVBERi0xLjQKJaqH...G9igo8PAovVGl0bG==
          - JVBERi0xLjQKJaqH...G9igo8PAovVGl0bG==
          items:
            type: string
          type: array
          nullable: true
        pdfBase64:
          title: Pdfbase64
          description: Base64 encoded PDF file
          example: JVBERi0xLjQKJaqH...G9igo8PAovVGl0bG==
          type: string
          nullable: true
      type: object
      title: CadastralOwnershipResponse
    CertificateOfOwnershipResponse:
      properties:
        algemeen:
          description: General object information
          allOf:
          - $ref: '#/components/schemas/Algemeen'
        aantekeningen:
          items:
            $ref: '#/components/schemas/AantekeningenItem'
          type: array
          title: Aantekeningen
          description: Information on judicial documents
        rechten:
          items:
            $ref: '#/components/schemas/RechtenItem'
          type: array
          title: Rechten
          description: Information on the granted rights
        signaleringstijdstip:
          type: string
          title: Signaleringstijdstip
          description: The date and time the report was generated.
          example: 29-08-2025 18:09
        jpegsBase64:
          title: Jpegsbase64
          description: This field contains a list of Base64 representations of the
            original PDF of Kadaster in JPEG formats.
          example:
          - JVBERi0xLjQKJaqH...G9igo8PAovVGl0bG==
          - JVBERi0xLjQKJaqH...G9igo8PAovVGl0bG==
          items:
            type: string
          type: array
          nullable: true
        pdfBase64:
          title: Pdfbase64
          description: This field contains the Base64 representation of the original
            PDF of Kadaster.
          example: JVBERi0xLjQKJaqH...G9igo8PAovVGl0bG==
          type: string
          nullable: true
      type: object
      title: CertificateOfOwnershipResponse
    CommercialTransactionsResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/CommercialTransaction'
          type: array
          title: Items
      type: object
      required:
      - items
      title: CommercialTransactionsResponse
    HomevalueAvailableResponse:
      properties:
        available:
          type: boolean
          title: Available
      type: object
      required:
      - available
      title: HomevalueAvailableResponse
    HomevalueResponse:
      properties:
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        street:
          type: string
          title: Street
          description: Street name
          example: Graafland
        city:
          type: string
          title: City
          description: City
          example: Laren
        municipality:
          type: string
          title: Municipality
          description: Municipality name
          example: Laren (NH.)
        state:
          type: string
          title: State
          description: Province/state
          example: Noord-Holland
        country:
          type: string
          title: Country
          description: Country
          example: The Netherlands
        bagId:
          type: string
          title: Bagid
          description: Identification number according to the BAG.
          example: 0417200000001419
        energyLabel:
          title: Energylabel
          description: A label indicating how well the property object is insulated.
          example: E
          type: string
          nullable: true
        rooms:
          title: Rooms
          description: Number of rooms
          example: 5
          type: integer
          nullable: true
        monument:
          title: Monument
          description: Boolean indicating whether the house is a monument.
          example: false
          type: boolean
          nullable: true
        valueDate:
          type: string
          format: date
          title: Valuedate
          description: Valuation date
          example: '2025-11-10'
        indexedPrice:
          title: Indexedprice
          description: The price of the transaction, indexed to the valuation date??
          type: integer
          nullable: true
        buildYear:
          title: Buildyear
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 2020
          type: integer
          nullable: true
        inputBuildYear:
          title: Inputbuildyear
          description: Build year as inputted by the user.
          type: integer
          nullable: true
        useSurface:
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 104
          type: integer
          nullable: true
        inputUseSurface:
          title: Inputusesurface
          description: Use surface as inputted by the user.
          type: integer
          nullable: true
        volume:
          title: Volume
          description: Volume in cubic meters.
          example: 411
          type: integer
          nullable: true
        parcelSurface:
          title: Parcelsurface
          description: The lot/parcel surface in m2.
          example: 338
          type: integer
          nullable: true
        inputParcelSurface:
          title: Inputparcelsurface
          description: Parcel surface as inputted by the user.
          type: integer
          nullable: true
        buildType:
          title: Buildtype
          description: Dwelling type
          example: 2-onder-1-kapwoning
          type: string
          nullable: true
        inputBuildType:
          title: Inputbuildtype
          description: Dwelling type as inputted by the user.
          type: string
          nullable: true
        predictedValue:
          type: integer
          title: Predictedvalue
        accuracy:
          title: Accuracy
          type: number
          nullable: true
        confidenceClass:
          title: Confidenceclass
          type: integer
          nullable: true
        histTransactionPrice:
          title: Histtransactionprice
          type: integer
          nullable: true
        histTransactionDate:
          title: Histtransactiondate
          type: string
          format: date
          nullable: true
        references:
          items:
            $ref: '#/components/schemas/ReferenceObjectModel'
          type: array
          title: References
        weightedValue:
          type: integer
          title: Weightedvalue
        numZipAllTypes:
          title: Numzipalltypes
          type: integer
          nullable: true
        medZipAllTypes:
          title: Medzipalltypes
          type: integer
          nullable: true
        numZipSameType:
          title: Numzipsametype
          type: integer
          nullable: true
        medZipSameType:
          title: Medzipsametype
          type: integer
          nullable: true
        numStrAllTypes:
          title: Numstralltypes
          type: integer
          nullable: true
        medStrAllTypes:
          title: Medstralltypes
          type: integer
          nullable: true
        numStrSameType:
          title: Numstrsametype
          type: integer
          nullable: true
        medStrSameType:
          title: Medstrsametype
          type: integer
          nullable: true
      type: object
      required:
      - houseNumber
      - postalCode
      - street
      - city
      - municipality
      - state
      - country
      - bagId
      - valueDate
      - predictedValue
      - references
      - weightedValue
      title: HomevalueResponse
    HomevalueValueResponse:
      properties:
        weightedValue:
          type: integer
          title: Weightedvalue
        confidenceClass:
          title: Confidenceclass
          type: integer
          nullable: true
      type: object
      required:
      - weightedValue
      title: HomevalueValueResponse
    HouseAndHoodResponse:
      properties:
        postcode:
          type: string
          title: Postcode
          description: Zipcode
          example: 1251NJ
        woonplaats:
          type: string
          title: Woonplaats
          description: City
          example: Laren
        straatnaam:
          type: string
          title: Straatnaam
          description: Street
          example: Graafland
        huisnummer:
          type: integer
          title: Huisnummer
          description: House number
          example: 22
        huisnummertoevoeging:
          title: Huisnummertoevoeging
          description: House number extention
          example: null
          type: string
          nullable: true
        huisletter:
          title: Huisletter
          description: House Letter
          example: null
          type: string
          nullable: true
        monumentaanduiding:
          type: boolean
          title: Monumentaanduiding
          description: Is monument
          example: false
        bouwjaar:
          type: integer
          title: Bouwjaar
          description: Build year
          example: 1955
        woz_waardeontwikkeling:
          type: string
          title: Woz Waardeontwikkeling
          description: WOZ value development
          example: '36'
        type_opstal:
          title: Type Opstal
          description: Dwelling type
          example: 2-onder-1-kapwoning
          type: string
          nullable: true
        inhoud:
          type: integer
          title: Inhoud
          description: Volume
          example: 411
        oppervlakte:
          type: integer
          title: Oppervlakte
          description: Use surface
          example: 104
        identificatie:
          type: string
          title: Identificatie
          description: Bag nummeraanduiding id
          example: 0417200000001419
        bouwstatus:
          type: string
          title: Bouwstatus
          description: Building/object status
          example: Verblijfsobject in gebruik
        gebruiksfunctie:
          type: string
          title: Gebruiksfunctie
          description: Use purpose
          example: woonfunctie
        identificatie_verblijfsobject:
          type: string
          title: Identificatie Verblijfsobject
          description: BAG verblijfsobject id
          example: 0417010001001419
        identificatie_pand:
          type: string
          title: Identificatie Pand
          description: BAG building id
          example: 0417100000005928
        plaats:
          type: string
          title: Plaats
          description: City
          example: Laren
        gebruiksoppervlakte:
          type: integer
          title: Gebruiksoppervlakte
          description: Use surface
          example: 104
        aantal_kamers:
          title: Aantal Kamers
          description: Number of rooms
          example: 3 kamers
          type: string
          nullable: true
        woz_waardeindicatie:
          title: Woz Waardeindicatie
          description: WOZ value indicator
          example: '930000'
          type: integer
          nullable: true
        omgevingsinformatie:
          items:
            $ref: '#/components/schemas/OmgevingsinformatieItem'
          type: array
          title: Omgevingsinformatie
          description: Surroundings information
        locatieomschrijving:
          title: Locatieomschrijving
          description: Location description
          example: null
          type: string
          nullable: true
        corop_gebied:
          title: Corop Gebied
          description: Corop area name
          example: null
          type: string
          nullable: true
        corop_gebied_code:
          title: Corop Gebied Code
          description: Corop area code
          example: null
          type: string
          nullable: true
        herbouwwaarde_indicatie:
          title: Herbouwwaarde Indicatie
          description: Rebuild value indicator
          example: null
          type: integer
          nullable: true
        betrouwbaarheid_herbouwwaarde:
          title: Betrouwbaarheid Herbouwwaarde
          description: Accuracy of rebuild value
          example: null
          type: number
          nullable: true
        marge_herbouwwaarde:
          title: Marge Herbouwwaarde
          description: Rebuild value margin
          example: null
          type: number
          nullable: true
        toegepast_hermesmodel:
          title: Toegepast Hermesmodel
          description: Used Hermes model
          example: null
          type: string
          nullable: true
        marge_woz_waardeindicatie:
          type: integer
          title: Marge Woz Waardeindicatie
          description: Margin WOZ value indication
          default: 0
          example: null
        complexinformatie:
          title: Complexinformatie
          description: Complex information
          example: null
          type: string
          nullable: true
        eigendom_gebruik_indicatie:
          title: Eigendom Gebruik Indicatie
          description: Ownership usage indication
          example: null
          type: string
          nullable: true
        grondoppervlakte_hoofdgebouw:
          title: Grondoppervlakte Hoofdgebouw
          description: Ground surface area main building
          example: null
          type: integer
          nullable: true
      type: object
      required:
      - postcode
      - woonplaats
      - straatnaam
      - huisnummer
      - bouwjaar
      - woz_waardeontwikkeling
      - inhoud
      - oppervlakte
      - identificatie
      - bouwstatus
      - gebruiksfunctie
      - identificatie_verblijfsobject
      - identificatie_pand
      - plaats
      - gebruiksoppervlakte
      - omgevingsinformatie
      title: HouseAndHoodResponse
    HouseDetailsResponse:
      properties:
        objectType:
          title: Objecttype
          description: The type of dwelling.
          example: 2-onder-1-kapwoning
          type: string
          nullable: true
        buildYear:
          title: Buildyear
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
          type: integer
          nullable: true
        livingSurface:
          title: Livingsurface
          description: The usable surface area (m2) inside the object with a residential
            function
          example: 104
          type: integer
          nullable: true
        otherIndoorSpace:
          title: Otherindoorspace
          description: The usable surface area (m2) inside the object without a residential
            function
          example: 6
          type: integer
          nullable: true
        useSurface:
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 110
          type: integer
          nullable: true
        parcelSurface:
          title: Parcelsurface
          description: The lot/parcel surface in m2.
          example: 338
          type: integer
          nullable: true
        energyLabel:
          title: Energylabel
          description: A label indicating how well the property object is insulated.
          example: E
          type: string
          nullable: true
        description:
          title: Description
          description: Description of the property object.
          example: "Bijzonder trots dat wij u mogen aanbieden: Dit huis in Laren!\
            \ Het huis is een droomhuis dat alles biedt wat u zoekt in een woning.\
            \ Het is ruim, karaktervol en voorzien van alle moderne luxe. De geweldige\
            \ locatie nabij de diverse sportfaciliteiten, het gezellige dorpscentrum\
            \ van Laren en zelfs het bos maakt het plaatje compleet.Maar het huis\
            \ zelf is misschien nog wel indrukwekkender.De woning is gebouwd in 1955,\
            \ fraai gemoderniseerd en uitgebouwd. En er is een royale oprit die ruimte\
            \ biedt aan meerdere auto's, een fraaie voortuin en niet te vergeten een\
            \ geweldige achtertuin met veel privacy en een sfeervolle veranda met\
            \ open haard en buitenbar! Om lange avonden te genieten van het buitenleven!\
            \ Tevens is er een garage.Begane grond:Entree met hal, meterkast, trapkast\
            \ en moderne toiletruimte met fontein. Stalen deur naar de ruime, gezellige\
            \ leefkeuken.Het spoeleiland fungeert als het centrale element in de keuken,\
            \ waardoor het een echt middelpunt vormt in deze ruimte. De keuken is\
            \ verder voorzien van alle wenselijke apparatuur waaronder een Quooker,\
            \ vaatwasser, koelkast en vriezer en een indrukwekkend gasfornuis. Dankzij\
            \ het overvloedige natuurlijke licht dat de ruimte binnenvalt, voelt deze\
            \ heerlijk comfortabel aan.De woonkamer nodigt uit tot ontspanning, de\
            \ open haard en de fraaie eikenhouten vloer geven de woonkamer net dat\
            \ beetje extra karakter.Via openslaande deuren aan de achterzijde van\
            \ de woning is de tuin te bereiken, waardoor binnen en buiten naadloos\
            \ in elkaar overlopen en \xE9\xE9n geheel vormen.Eerste verdieping:Een\
            \ dichte trap leidt naar de verdieping. Er is een ruime slaapkamer aan\
            \ de voorzijde van de woning, met een ingebouwde kast voor extra opbergruimte.\
            \ Aan de achterzijde bevindt zich nog een grote slaapkamer, compleet met\
            \ een balkon voor een heerlijke buitenruimte. Een derde slaapkamer is\
            \ tevens gelegen aan de achterzijde en beschikt tevens over een praktische\
            \ vaste kast.De badkamer is luxe afgewerkt. De wanden zij fraai gestuukt\
            \ in een mooie kleurstelling, voorzien van een dubbele wastafelmeubel,\
            \ hangend toilet, handdoekradiator en een ruime inloopdouche.Tweede verdieping:Een\
            \ vaste trap leidt naar de zolderverdieping, waar op de voorzolder plek\
            \ is voor uw wasmachine- en drogeropstelling. De zolderkamer wordt thans\
            \ gebruikt als logeerruimte en kan voorzien worden door een nokverhoging\
            \ en dakkapellen.Tuin: De achtertuin is omsloten door groen en garandeert\
            \ meer dan voldoende privacy en is afgesloten door een poort. De veranda\
            \ met open haard maakt het plaatje compleet.Bijzonderheden:- Kindvriendelijke\
            \ locatie;- Ruime straat met veel groen;- Uitgebouwd;- Zeer lichte woning;-\
            \ Ideaal (gezins)huis;- Extra uitbouwmogelijkheden;- Zeer geliefde woonomgeving.Nieuwsgierig\
            \ geworden? Bel ons voor het maken van een afspraak, wij leiden u graag\
            \ rond!"
          type: string
          nullable: true
        numberOfRooms:
          title: Numberofrooms
          description: Number of rooms.
          example: 5
          type: integer
          nullable: true
        numberOfBedrooms:
          title: Numberofbedrooms
          description: Number of bedrooms.
          example: 3
          type: integer
          nullable: true
        numberOfBathrooms:
          title: Numberofbathrooms
          description: Number of bathrooms.
          example: 1
          type: integer
          nullable: true
        numberOfToilets:
          title: Numberoftoilets
          description: Number of toilets.
          example: 1
          type: integer
          nullable: true
        attachedOutdoorSpace:
          title: Attachedoutdoorspace
          description: Attached outdoor spaces in m2.
          example: 0
          type: integer
          nullable: true
        externalStorageSpace:
          title: Externalstoragespace
          description: External sotrage space in m2.
          example: 22
          type: integer
          nullable: true
        volume:
          title: Volume
          description: Volume in m3.
          example: 411
          type: integer
          nullable: true
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
      type: object
      required:
      - postalCode
      - houseNumber
      title: HouseDetailsResponse
    HouseImagesResponse:
      properties:
        address:
          description: Address
          allOf:
          - $ref: '#/components/schemas/Address'
        images:
          items:
            type: string
          type: array
          title: Images
          description: Images
          example:
          - https://images.matrixiangroup.com/187/536/548_1440.jpg
          - https://images.matrixiangroup.com/187/536/549_1440.jpg
      type: object
      required:
      - address
      - images
      title: HouseImagesResponse
    LeadtoolResponse:
      properties:
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        references:
          items:
            $ref: '#/components/schemas/LeadtoolReferenceModel'
          type: array
          title: References
          description: List of reference objects.
        weightedValue:
          type: integer
          title: Weightedvalue
        weightedValueRange:
          type: string
          title: Weightedvaluerange
      type: object
      required:
      - houseNumber
      - postalCode
      - references
      - weightedValue
      - weightedValueRange
      title: LeadtoolResponse
    LocalTaxEnergyResponse:
      properties:
        inputPostcode:
          type: string
          title: Inputpostcode
          description: Postal code
          example: 1251NJ
        inputHouseNumber:
          type: integer
          title: Inputhousenumber
          description: House number
          example: 22
        inputHouseNumberExt:
          title: Inputhousenumberext
          description: House number extension
          type: string
          nullable: true
        municipalTaxes:
          description: Object containing municipal taxes
          allOf:
          - $ref: '#/components/schemas/MunicipalTaxes'
        municipalityCode:
          type: string
          title: Municipalitycode
          description: Municipality code
          example: 417
        utilities:
          description: Object containing utility usage
          allOf:
          - $ref: '#/components/schemas/Utilities'
        municipalityName:
          type: string
          title: Municipalityname
          description: Municipality name
          example: Laren (NH.)
      type: object
      required:
      - inputPostcode
      - inputHouseNumber
      - municipalTaxes
      - municipalityCode
      - utilities
      - municipalityName
      title: LocalTaxEnergyResponse
    ModelwaardeBeschikbaarResponse:
      properties:
        modelwaardebeschikbaar:
          type: boolean
          title: Modelwaardebeschikbaar
      type: object
      required:
      - modelwaardebeschikbaar
      title: ModelwaardeBeschikbaarResponse
    ModelwaardeResponse:
      properties:
        taxatieobject:
          $ref: '#/components/schemas/TaxatieModel'
        modelwaardedata:
          $ref: '#/components/schemas/ModelwaardedataModel'
        referentieobjecten:
          items:
            $ref: '#/components/schemas/ReferentieModel'
          type: array
          title: Referentieobjecten
      type: object
      required:
      - taxatieobject
      - modelwaardedata
      - referentieobjecten
      title: ModelwaardeResponse
    MxReferenceFinderAvailableResponse:
      properties:
        nReferences:
          type: integer
          title: Nreferences
          description: Amount of references found.
          example: 43
        nReferencesHiQ:
          type: integer
          title: Nreferenceshiq
          description: Amount of references with a similarity score higher than 80.
          example: 33
      type: object
      required:
      - nReferences
      - nReferencesHiQ
      title: MxReferenceFinderAvailableResponse
    MxReferenceFinderResponse:
      properties:
        postal_code:
          type: string
          title: Postal Code
          description: Postal code
          example: 1251NJ
        house_number:
          type: integer
          title: House Number
          description: House number
          example: 22
        house_letter:
          title: House Letter
          description: House letter
          example: null
          type: string
          nullable: true
        house_number_ext:
          title: House Number Ext
          description: House number extention
          example: null
          type: string
          nullable: true
        house_type:
          type: string
          title: House Type
          description: Dwelling type
          example: 2-onder-1-kapwoning
        build_year:
          type: integer
          title: Build Year
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
        use_surface:
          type: integer
          title: Use Surface
          description: The usable surface area of a property object in square meters.
          example: 104
        use_surface_bag:
          type: integer
          title: Use Surface Bag
          description: The usable surface area of a property object in square meters
            according to the BAG.
          example: 104
        parcel_surface:
          type: integer
          title: Parcel Surface
          description: The lot/parcel surface in m2.
          example: 338
        references:
          items:
            $ref: '#/components/schemas/ReferenceResponse'
          type: array
          title: References
          description: List of references
        valuation_date:
          type: string
          format: date
          title: Valuation Date
          description: The date of the valuation
          example: '2025-11-10'
        front_image_url:
          title: Front Image Url
          description: The front image url of the house/object.
          type: string
          nullable: true
        energy_label:
          title: Energy Label
          description: A label indicating how well the property object is insulated.
          example: E
          type: string
          nullable: true
        energy_label_registration_valid_until:
          title: Energy Label Registration Valid Until
          description: Date until which the energy label is valid.
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        volume:
          title: Volume
          description: Volume in m3.
          example: 411
          type: integer
          nullable: true
        storage_space:
          title: Storage Space
          description: Storage space
          type: string
          nullable: true
        garage:
          title: Garage
          description: Garage
          type: string
          nullable: true
        description:
          title: Description
          description: Description
          type: string
          nullable: true
        date_transaction:
          title: Date Transaction
          description: Date of transaction
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        transaction_price_indexed:
          title: Transaction Price Indexed
          description: The price of the transaction, indexed to the valuation date??
          type: integer
          nullable: true
        transactions_price_indexed_date_transport:
          title: Transactions Price Indexed Date Transport
          description: The price of the transaction, indexed to the transport date.
          type: integer
          nullable: true
        transaction_price_indexed_date_sale:
          title: Transaction Price Indexed Date Sale
          description: The price of the transaction, indexed to the sale date.
          type: integer
          nullable: true
        date_sale:
          title: Date Sale
          description: Date of sale
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        date_transport:
          title: Date Transport
          description: Date of transport
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
      type: object
      required:
      - postal_code
      - house_number
      - house_type
      - build_year
      - use_surface
      - use_surface_bag
      - parcel_surface
      - valuation_date
      - energy_label
      - volume
      - storage_space
      - transaction_price_indexed
      title: MxReferenceFinderResponse
    MxTransactionsResponse:
      properties:
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        transactionDate:
          type: string
          format: date
          title: Transactiondate
          description: Transaction date
          example: '2025-11-10'
        transactionPrice:
          type: integer
          title: Transactionprice
          description: Transaction price
        transactionPriceIndexed:
          type: integer
          title: Transactionpriceindexed
          description: The price of the transaction, indexed to the valuation date.
        valuationDate:
          type: string
          format: date
          title: Valuationdate
          description: Valuation date
          example: '2025-11-10'
      type: object
      required:
      - postalCode
      - houseNumber
      - transactionDate
      - transactionPrice
      - transactionPriceIndexed
      - valuationDate
      title: MxTransactionsResponse
    TransactionFinderResponse:
      properties:
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        saleDate:
          title: Saledate
          description: Sale date
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        transportDate:
          type: string
          format: date
          title: Transportdate
          description: Transport date
          example: '2025-11-10'
        transactionDate:
          type: string
          format: date
          title: Transactiondate
          description: Transaction date
          example: '2025-11-10'
        transactionPrice:
          type: integer
          title: Transactionprice
          description: Transaction price
        transactionPriceIndexed:
          type: integer
          title: Transactionpriceindexed
          description: The price of the transaction, indexed to the valuation date.
        transactionPriceIndexedDateTransport:
          type: integer
          title: Transactionpriceindexeddatetransport
          description: The price of the transaction, indexed to the transport date.
        transactionPriceIndexedDateSale:
          title: Transactionpriceindexeddatesale
          description: The price of the transaction, indexed to the sale date.
          type: integer
          nullable: true
        valuationDate:
          type: string
          format: date
          title: Valuationdate
          description: Valuation date
          example: '2025-11-10'
      type: object
      required:
      - postalCode
      - houseNumber
      - saleDate
      - transportDate
      - transactionDate
      - transactionPrice
      - transactionPriceIndexed
      - transactionPriceIndexedDateTransport
      - transactionPriceIndexedDateSale
      - valuationDate
      title: TransactionFinderResponse
    WozReferenceFinderResponse:
      properties:
        fiscalYear:
          type: integer
          title: Fiscalyear
          description: Fiscal year
          example: 2024
        valuationObject:
          $ref: '#/components/schemas/ValuationObjectResponse'
        referenceObjects:
          items:
            $ref: '#/components/schemas/ReferenceObjectsResponse'
          type: array
          title: Referenceobjects
      type: object
      required:
      - fiscalYear
      - valuationObject
      - referenceObjects
      title: WozReferenceFinderResponse
    WozValueResponse:
      properties:
        id:
          type: string
          title: Bag nummeraanduidingid
          description: Identification number according to the BAG.
          example: 0417200000001419
        address:
          type: string
          title: Address
          description: Formatted address string of the WOZ object
          example: Graafland 22, 1251NJ Laren
        city:
          type: string
          title: City
          description: City in which the WOZ object is located
          example: Laren
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode of the WOZ object
          example: 1251NJ
        houseNumber:
          type: integer
          title: Huisnummer
          description: House number of the WOZ object
          example: 22
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        characteristics:
          description: Characteristics of the WOZ object
          allOf:
          - $ref: '#/components/schemas/Characteristics'
        wozValues:
          items:
            $ref: '#/components/schemas/WozValues'
          type: array
          title: WOZ values
          description: WOZ values per valuation date.
      type: object
      required:
      - id
      - address
      - city
      - postalCode
      - houseNumber
      - characteristics
      - wozValues
      title: WozValueResponse
    WozViabilityResponse:
      properties:
        viabilityCheck:
          type: boolean
          title: Viabilitycheck
          default: false
        AVMCheck:
          type: boolean
          title: Avmcheck
          default: false
        WOZCheck:
          type: boolean
          title: Wozcheck
          default: false
        ObjectCheck:
          type: boolean
          title: Objectcheck
          default: false
        ReferenceCheck:
          type: boolean
          title: Referencecheck
          default: false
      type: object
      title: WozViabilityResponse
    Aantekening:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        aard:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        betreftGedeelteVanPerceel:
          title: Betreftgedeeltevanperceel
          type: boolean
          nullable: true
        einddatum:
          title: Einddatum
          type: string
          nullable: true
        einddatumRecht:
          title: Einddatumrecht
          type: string
          nullable: true
        omschrijving:
          title: Omschrijving
          type: string
          nullable: true
        aantekeningKadastraalObject:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        aantekeningRecht:
          title: Aantekeningrecht
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isGebaseerdOp:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        betrokkenPersoon:
          title: Betrokkenpersoon
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
      type: object
      title: Aantekening
    AantekeningenItem:
      properties:
        afkomstigUitStuk:
          title: Afkomstiguitstuk
          description: Unique number of a deed
          example: Hyp4 58968/193
          type: string
          nullable: true
        afkomstigUitStukIngeschrevenOp:
          title: Afkomstiguitstukingeschrevenop
          description: Date of registration
          example: 29-08-2025
          type: string
          nullable: true
        afkomstigUitStukSoort:
          title: Afkomstiguitstuksoort
          description: Type of registration
          type: string
          nullable: true
        basisregistratieKadasterBeperking:
          title: Basisregistratiekadasterbeperking
          description: Regulations by Kadaster
          type: string
          nullable: true
        basisregistratieLandelijkeVoorziening:
          title: Basisregistratielandelijkevoorziening
          description: Regulations by Landelijke Voorziening
          type: string
          nullable: true
        betrokkenBestuursorgaan:
          title: Betrokkenbestuursorgaan
          description: Concerned administrative entity
          example: De Statutaire Naam 83243310
          type: string
          nullable: true
        overigeAantekening:
          title: Overigeaantekening
          description: Additional notes
          example: Besluit op grond van artikel 110 I Wet geluidhinder
          type: string
          nullable: true
        vermeldInStuk:
          title: Vermeldinstuk
          description: Unique number of a deed
          example: Hyp4 58968/193
          type: string
          nullable: true
        vermeldInStukIngeschrevenOp:
          title: Vermeldinstukingeschrevenop
          description: Date of registration
          example: 29-08-2025
          type: string
          nullable: true
        vermeldInStukSoort:
          title: Vermeldinstuksoort
          description: Type of registration
          type: string
          nullable: true
      type: object
      title: AantekeningenItem
    AanvullendeGegevens:
      properties:
        bijIdentificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        soort:
          title: Soort
          type: string
          nullable: true
        gegevens:
          title: Gegevens
          type: string
          nullable: true
      type: object
      title: AanvullendeGegevens
    AanvullendeKenmerkenModel:
      properties:
        bijgebouwen:
          $ref: '#/components/schemas/TekstveldmetbronModel'
        locatie:
          $ref: '#/components/schemas/TekstveldmetbronModel'
        omgeving:
          $ref: '#/components/schemas/TekstveldmetbronModel'
        bereikbaarheid:
          $ref: '#/components/schemas/TekstveldmetbronModel'
        voorzieningen:
          $ref: '#/components/schemas/TekstveldmetbronModel'
      type: object
      required:
      - bijgebouwen
      - locatie
      - omgeving
      - bereikbaarheid
      - voorzieningen
      title: AanvullendeKenmerkenModel
    AanvullendeStukkenItem:
      properties:
        aanvullendeStuk:
          title: Aanvullendestuk
          description: Unique number of a deed
          example: Hyp4 58968/193
          type: string
          nullable: true
        aanvullendeStukIngeschrevenOp:
          title: Aanvullendestukingeschrevenop
          description: Date of registration
          example: 29-08-2025
          type: string
          nullable: true
        isAanvullingOpStuk:
          title: Isaanvullingopstuk
          description: Document this deed extends
          example: Hyp4 58968/193
          type: string
          nullable: true
      type: object
      title: AanvullendeStukkenItem
    Address:
      properties:
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
      type: object
      required:
      - postalCode
      - houseNumber
      title: Address
    AddressResponse:
      properties:
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        streetName:
          type: string
          title: Streetname
          description: Street name
          example: Graafland
      type: object
      required:
      - postalCode
      - houseNumber
      - streetName
      title: AddressResponse
    AddressSuggestionItem:
      properties:
        country:
          type: string
          title: Country
          default: NLD
        state:
          type: string
          title: State
          description: State
          example: Noord-Holland
        city:
          type: string
          title: City
          description: City
          example: Laren
        street:
          type: string
          title: Street
          description: Street name
          example: Graafland
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        buildType:
          title: Buildtype
          description: Dwelling type
          example: 2-onder-1-kapwoning
          type: string
          nullable: true
        formattedAddress:
          type: string
          title: Formattedaddress
          description: Formatted address string of the object
          example: Graafland 22, 1251NJ Laren
        buildYear:
          type: integer
          title: Buildyear
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
        parcelSurface:
          title: Parcelsurface
          description: The lot/parcel surface in m2.
          example: 338
          type: integer
          nullable: true
        useSurface:
          type: integer
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 104
        volume:
          title: Volume
          description: Volume in m3.
          example: 411
          type: integer
          nullable: true
        marketValue:
          title: Marketvalue
          description: Market value
          type: integer
          nullable: true
        latitude:
          type: number
          title: Latitude
          description: Latitude
          example: 52.25291881
        longitude:
          type: number
          title: Longitude
          description: Longitude
          example: 5.23903348
        propertyNumberId:
          type: string
          title: Propertynumberid
          description: Property number ID
          example: 0417200000001419
        houseDetailsBuildType:
          title: Housedetailsbuildtype
          description: Dwelling type
          example: 2-onder-1-kapwoning
          type: string
          nullable: true
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        extension:
          title: Extension
          description: House number extension
          example: null
          type: string
          nullable: true
        energyLabel:
          title: Energylabel
          description: A label indicating how well the property object is insulated.
          example: E
          type: string
          nullable: true
      type: object
      required:
      - state
      - city
      - street
      - houseNumber
      - postalCode
      - formattedAddress
      - buildYear
      - useSurface
      - latitude
      - longitude
      - propertyNumberId
      title: AddressSuggestionItem
    AdresBuitenland:
      properties:
        adres:
          title: Adres
          type: string
          maxLength: 50
          minLength: 1
          nullable: true
        identificatie:
          allOf:
          - $ref: '#/components/schemas/Adresnummer'
          nullable: true
        land:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        regio:
          title: Regio
          type: string
          maxLength: 39
          minLength: 1
          nullable: true
        woonplaats:
          title: Woonplaats
          type: string
          maxLength: 80
          minLength: 1
          nullable: true
      type: object
      title: AdresBuitenland
    AdresModel:
      properties:
        huisletter:
          title: Huisletter
          description: House letter
          example: null
          type: string
          nullable: true
        huisnummer:
          type: integer
          title: Huisnummer
          description: House number
          example: 22
        huisnummertoevoeging:
          title: Huisnummertoevoeging
          description: House number extention
          example: null
          type: string
          nullable: true
        postcode:
          type: string
          title: Postcode
          description: Zipcode
          example: 1251NJ
        plaats:
          type: string
          title: Plaats
          description: City
          example: Laren
        straat:
          type: string
          title: Straat
          description: Street
          example: Graafland
      type: object
      required:
      - huisnummer
      - postcode
      - plaats
      - straat
      title: AdresModel
    Adresnummer:
      type: string
      title: Adresnummer
    AfkomstigUitStukkenItem:
      properties:
        afkomstigUitStuk:
          title: Afkomstiguitstuk
          description: Document this deed originates from
          example: Hyp4 58968/193
          type: string
          nullable: true
        afkomstigUitStukIngeschrevenOp:
          title: Afkomstiguitstukingeschrevenop
          description: Date of registration
          example: 29-08-2025
          type: string
          nullable: true
        afkomstigUitStukSoort:
          title: Afkomstiguitstuksoort
          description: Type of registration
          type: string
          nullable: true
      type: object
      title: AfkomstigUitStukkenItem
    Algemeen:
      properties:
        coordinaten:
          title: Coordinaten
          description: The RD-coordinates of the parcel
          example: 154940 - 422927
          type: string
          nullable: true
        kadastraleAanduiding:
          title: Kadastraleaanduiding
          description: The cadastral indication is the characteristic of a cadastral
            parcel
          example: Alem C 1561
          type: string
          nullable: true
        kadastraleGrensEnGrootte:
          title: Kadastralegrensengrootte
          description: Type of boundary can be fixed, provisional or administrative.
            In the case of provisional or administrative, the parcel must still be
            measured
          example: Vastgesteld
          type: string
          nullable: true
        kadastraleGrootte:
          title: Kadastralegrootte
          description: The parcel surface in square meters
          example: 2440
          type: integer
          nullable: true
        kadastraleObjectidentificatie:
          title: Kadastraleobjectidentificatie
          description: Cadastral Object ID
          example: 088980256170000
          type: string
          nullable: true
        kadastraleOmschrijving:
          title: Kadastraleomschrijving
          description: Description
          example: Wonen
          type: string
          nullable: true
        koopjaar:
          title: Koopjaar
          description: The year the purchase was made
          example: 2025
          type: integer
          nullable: true
        koopsom:
          title: Koopsom
          description: The purchase price of the home
          example: 580000
          type: integer
          nullable: true
        locatie:
          title: Locatie
          description: The address(es) associated with the parcel
          example: Provincialeweg 57, 5398 JJ Maren-Kessel
          type: string
          nullable: true
        omschrijving:
          title: Omschrijving
          description: In most cases, the description of the plot at the time of acquisition
          example: Wonen
          type: string
          nullable: true
        ontstaanUit:
          title: Ontstaanuit
          description: The cadastral designation of the original parcel (prior the
            parcel split)
          example: Alem C 1513
          type: string
          nullable: true
        verblijfsobjectID:
          title: Verblijfsobjectid
          description: Residence Object ID
          example: '0344010000012345'
          type: string
          nullable: true
        verenigingVanEigenaren:
          title: Verenigingvaneigenaren
          description: An association of owners is a legal person that represents
            the common interests of apartment owners
          example: VvE Van Velzen
          type: string
          nullable: true
      type: object
      title: Algemeen
    AppartementsrechtSplitsing:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/AppartementsrechtSplitsingTypeEnum'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        heeftVerenigingVanEigenaren:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isGebaseerdOp:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: AppartementsrechtSplitsing
    AppartementsrechtSplitsingTypeEnum:
      type: string
      enum:
      - Hoofsplitsing
      - Ondersplitsing
      - SpiegelsplitsingOndersplitsing
      - SpiegelsplitsingAfkoopErfpacht
      title: AppartementsrechtSplitsingTypeEnum
    AttenderingKadastraalObject:
      properties:
        van:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        tenBehoeveVan:
          title: tenBehoeveVan
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
      type: object
      title: AttenderingKadastraalObject
    Bedrag:
      properties:
        som:
          title: Som
          type: number
          nullable: true
        valuta:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
      type: object
      title: Bedrag
    Beperkingsgebied:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        ontleendAan:
          title: Ontleendaan
          items:
            $ref: '#/components/schemas/ObjectReferentie'
          type: array
          nullable: true
      type: object
      title: Beperkingsgebied
    BestandModel:
      properties:
        bytes:
          title: Bytes
          type: string
          nullable: true
        type:
          title: Type
          type: string
          nullable: true
        url:
          title: Url
          type: string
          nullable: true
      type: object
      title: BestandModel
    Building:
      properties:
        beginDate:
          type: string
          title: Begindate
          description: Beginning date
          example: '2018-12-06T00:00:00+00:00'
        buildYear:
          type: integer
          title: Buildyear
          description: 'Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year. '
          example: 1955
        documentDate:
          type: string
          title: Documentdate
          description: Date of document
          example: '2018-12-06T00:00:00+00:00'
        documentNumber:
          type: string
          title: Documentnumber
          description: Number of the document
          example: 2018-0887
        id:
          type: string
          title: Id
          description: Identification
          example: 0417100000005928
        mutationDate:
          title: Mutationdate
          description: Mutatation date
          example: null
          type: string
          nullable: true
        noted:
          type: boolean
          title: Noted
          description: Any information that was stated.
          example: false
        status:
          type: string
          title: Status
          description: Status of the building.
          example: Pand in gebruik
      type: object
      required:
      - beginDate
      - buildYear
      - documentDate
      - documentNumber
      - id
      - noted
      - status
      title: Building
    Businesses:
      properties:
        waterConsumptionInCubicMeter:
          additionalProperties:
            $ref: '#/components/schemas/EuroObject'
          type: object
          title: Waterconsumptionincubicmeter
          description: "Water consumption (in m\xB3) by businesses"
      type: object
      required:
      - waterConsumptionInCubicMeter
      title: Businesses
    Characteristics:
      properties:
        buildType:
          type: string
          title: Buildtype
          description: Type of dwelling.
          example: 2-onder-1-kapwoning
        buildYear:
          type: integer
          title: Buildyear
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
        usePurpose:
          type: string
          title: Usepurpose
          description: The categorisation of the purposes of use of the relevant property
            object as stated in the permit or as established upon registration.
          example: woonfunctie
        useSurface:
          type: integer
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 104
      type: object
      required:
      - buildType
      - buildYear
      - usePurpose
      - useSurface
      title: Characteristics
    CommercialTransaction:
      properties:
        sourceFile:
          type: string
          title: Sourcefile
          description: Source file
          example: kadaster/transactions-COMPANY-2012-01-980a78eef1718a19a92d466927fc4501aba01749096efc69573ada202a0efd768cdd35b24f8f7b84a844d7451d203f89720e2d4394310be1d68deb1593bd3a23.csv
        overBewK:
          type: string
          title: Overbewk
          description: Custody code for the transaction.
          example: NL
        stukOntvDatum:
          type: string
          format: date
          title: Stukontvdatum
          description: Date the document was received.
          example: '20221230'
        overStuk:
          type: string
          title: Overstuk
          description: Unique identifier for the transaction document.
          example: NL4  8577500053
        nnpVerkoperCode:
          type: string
          title: Nnpverkopercode
          description: Code identifying the legal entity of the seller.
          example: BV
        nnpKoperCode:
          type: string
          title: Nnpkopercode
          description: Code identifying the legal entity of the buyer.
          example: BV
        objeMutSrtK:
          type: string
          title: Objemutsrtk
          description: Code for the type of mutation or transaction.
          example: '606'
        indFamTrans:
          type: string
          title: Indfamtrans
          description: Boolean indicating whether the transaction is a family transfer.
          example: N
        objeObjekt:
          type: string
          title: Objeobjekt
          description: Reference code for the object being transacted.
          example: RTD10AC00861G0000
        kadGem:
          type: string
          title: Kadgem
          description: Code representing the cadastral municipality.
          example: RTD10
        sectie:
          type: string
          title: Sectie
          description: Section code related to the property parcel.
          example: AC
        perceelnr:
          type: string
          title: Perceelnr
          description: Number representing the parcel within the section.
          example: 00861
        indexlt:
          type: string
          title: Indexlt
          description: Letter index for the property.
          example: G
        indexnr:
          type: string
          title: Indexnr
          description: Number index for the property.
          example: '0000'
        objeGrootte:
          type: string
          title: Objegrootte
          description: Size of the object, typically area in square meters.
          example: '1125'
        objeKoopSom:
          type: string
          title: Objekoopsom
          description: The purchase price of the property in the transaction.
          example: '875000'
        objeIndMeerOG:
          type: string
          title: Objeindmeerog
          description: Boolean indicating if the transaction involves multiple ownerships.
          example: J
        objeBurgGemNr:
          type: string
          title: Objeburggemnr
          description: Number identifier for the municipality.
          example: '599'
        objeBurgGemNaam:
          type: string
          title: Objeburggemnaam
          description: Name of the municipality where the property is located.
          example: ROTTERDAM
        objeKultOngebK:
          type: string
          title: Objekultongebk
          description: Cultural code for unbuilt structures.
          example: '00'
        zakrZrK:
          type: string
          title: Zakrzrk
          description: Code identifying any business rights attached to the transaction.
          example: EP
        toelichtingZakRecht:
          title: Toelichtingzakrecht
          description: Description of any business rights attached to the transaction.
          example: Recht van erfpacht
          type: string
          nullable: true
        objbObjBelK:
          type: string
          title: Objbobjbelk
          description: Code for any obstructions on the object.
          example: '   '
        objeXCoord:
          type: string
          title: Objexcoord
          description: X coordinate of the property's location.
          example: '88136'
        objeYCoord:
          type: string
          title: Objeycoord
          description: Y coordinate of the property's location.
          example: '437709'
        objeKultText:
          type: string
          title: Objekulttext
          description: Text providing cultural or contextual information about the
            property.
          example: PERCEEL GROND - GEBRUIK ONBEKEND
        objaKultGebK:
          type: string
          title: Objakultgebk
          description: Cultural code for built structures on the property.
          example: '00'
        objaPltsNaam:
          type: string
          title: Objapltsnaam
          description: Name of the place where the property is located.
          example: ROTTERDAM
        objaStraat:
          type: string
          title: Objastraat
          description: Street name of the property's location.
          example: STRICKLEDEWEG
        objaHuisNr:
          title: Objahuisnr
          description: House number of the property.
          example: '111'
          type: string
          nullable: true
        objaHuisLr:
          title: Objahuislr
          description: House letter if applicable, otherwise blank.
          example: ' '
          type: string
          nullable: true
        objaToevoeging:
          title: Objatoevoeging
          description: Any additional house extension code or description.
          example: null
          type: string
          nullable: true
        objaPttK:
          type: string
          title: Objapttk
          description: Postal code associated with the property.
          example: 3044EL
        pht:
          title: Pht
          description: Unique identifier for the address.
          example: 3044EL-111
          type: string
          nullable: true
        overId:
          type: string
          title: Overid
          description: Unique transfer identifier for the transaction.
          example: '100001892532'
        bagId:
          title: Bagid
          description: ID of the building associated with the transaction.
          example: null
          type: string
          nullable: true
      type: object
      required:
      - sourceFile
      - overBewK
      - stukOntvDatum
      - overStuk
      - nnpVerkoperCode
      - nnpKoperCode
      - objeMutSrtK
      - indFamTrans
      - objeObjekt
      - kadGem
      - sectie
      - perceelnr
      - indexlt
      - indexnr
      - objeGrootte
      - objeKoopSom
      - objeIndMeerOG
      - objeBurgGemNr
      - objeBurgGemNaam
      - objeKultOngebK
      - zakrZrK
      - objbObjBelK
      - objeXCoord
      - objeYCoord
      - objeKultText
      - objaKultGebK
      - objaPltsNaam
      - objaStraat
      - objaHuisNr
      - objaHuisLr
      - objaToevoeging
      - objaPttK
      - pht
      - overId
      title: CommercialTransaction
    EDICollectie:
      properties:
        aantekeningen:
          title: Aantekeningen
          items:
            $ref: '#/components/schemas/Aantekening'
          type: array
          nullable: true
        locatieKadastraalObjecten:
          title: Locatiekadastraalobjecten
          items:
            $ref: '#/components/schemas/LocatieKadastraalObject'
          type: array
          nullable: true
        onroerendeZaken:
          title: Onroerendezaken
          items:
            $ref: '#/components/schemas/Perceel'
          type: array
          nullable: true
        personen:
          title: Personen
          items:
            oneOf:
            - $ref: '#/components/schemas/NietNatuurlijkPersoon'
            - $ref: '#/components/schemas/NatuurlijkPersoon'
            discriminator:
              propertyName: type
              mapping:
                NatuurlijkPersoon: '#/components/schemas/NatuurlijkPersoon'
                NietNatuurlijkPersoon: '#/components/schemas/NietNatuurlijkPersoon'
          type: array
          nullable: true
        adresLocaties:
          title: Adreslocaties
          items:
            oneOf:
            - $ref: '#/components/schemas/ObjectlocatieBinnenland'
            - $ref: '#/components/schemas/ObjectlocatieBuitenland'
            - $ref: '#/components/schemas/PostbusLocatie'
            discriminator:
              propertyName: type
              mapping:
                ObjectlocatieBinnenland: '#/components/schemas/ObjectlocatieBinnenland'
                ObjectlocatieBuitenland: '#/components/schemas/ObjectlocatieBuitenland'
                PostbusLocatie: '#/components/schemas/PostbusLocatie'
          type: array
          nullable: true
        attenderingKadastraalObjecten:
          title: Attenderingkadastraalobjecten
          items:
            $ref: '#/components/schemas/AttenderingKadastraalObject'
          type: array
          nullable: true
        signaleringKadastraalObjecten:
          title: Signaleringkadastraalobjecten
          items:
            $ref: '#/components/schemas/SignaleringKadastraalObject'
          type: array
          nullable: true
        stukdelen:
          title: Stukdelen
          items:
            $ref: '#/components/schemas/Stukdeel'
          type: array
          nullable: true
        stukken:
          title: Stukken
          items:
            oneOf:
            - $ref: '#/components/schemas/Kadasterstuk'
            - $ref: '#/components/schemas/TerInschrijvingAangebodenStuk'
            discriminator:
              propertyName: type
              mapping:
                Kadasterstuk: '#/components/schemas/Kadasterstuk'
                TerInschrijvingAangebodenStuk: '#/components/schemas/TerInschrijvingAangebodenStuk'
          type: array
          nullable: true
        verblijfsobjecten:
          title: Verblijfsobjecten
          items:
            $ref: '#/components/schemas/Verblijfsobject'
          type: array
          nullable: true
        aanvullendeGegevens:
          title: Aanvullendegegevens
          items:
            $ref: '#/components/schemas/AanvullendeGegevens'
          type: array
          nullable: true
        erfpachtcanons:
          title: Erfpachtcanons
          items:
            $ref: '#/components/schemas/Erfpachtcanon'
          type: array
          nullable: true
        gezamenlijkAandelen:
          title: Gezamenlijkaandelen
          items:
            $ref: '#/components/schemas/GezamenlijkAandeel'
          type: array
          nullable: true
        mandeligheden:
          title: Mandeligheden
          items:
            $ref: '#/components/schemas/Mandeligheid'
          type: array
          nullable: true
        tenaamstellingen:
          title: Tenaamstellingen
          items:
            $ref: '#/components/schemas/Tenaamstelling'
          type: array
          nullable: true
        appartementsrechtSplitsingen:
          title: Appartementsrechtsplitsingen
          items:
            $ref: '#/components/schemas/AppartementsrechtSplitsing'
          type: array
          nullable: true
        publiekrechtelijkeBeperkingen:
          title: Publiekrechtelijkebeperkingen
          items:
            $ref: '#/components/schemas/PubliekrechtelijkeBeperking'
          type: array
          nullable: true
        beperkingsgebieden:
          title: Beperkingsgebieden
          items:
            $ref: '#/components/schemas/Beperkingsgebied'
          type: array
          nullable: true
        zakelijkRechten:
          title: Zakelijkrechten
          items:
            $ref: '#/components/schemas/ZakelijkRecht'
          type: array
          nullable: true
        verkavelObjecten:
          title: Verkavelobjecten
          items:
            $ref: '#/components/schemas/VerkavelObject'
          type: array
          nullable: true
        herverkavelingsgebieden:
          title: Herverkavelingsgebieden
          items:
            $ref: '#/components/schemas/Herverkavelingsgebied'
          type: array
          nullable: true
      type: object
      title: EDICollectie
    EnergyUsage:
      properties:
        apartment:
          title: Apartment
          description: Average energy usage of apartments
          example: 0.25
          type: number
          nullable: true
        average:
          title: Average
          description: Average energy usage of all house types
          example: 0.25
          type: number
          nullable: true
        cornerHouse:
          title: Cornerhouse
          description: Average energy usage of corner house
          example: 0.25
          type: number
          nullable: true
        detachedHouse:
          title: Detachedhouse
          description: Average energy usage of detached house
          example: 0.25
          type: number
          nullable: true
        ownedHomes:
          title: Ownedhomes
          description: Average energy usage of owned homes
          example: 0.25
          type: number
          nullable: true
        rentalHomes:
          title: Rentalhomes
          description: Average energy usage of rental homes
          example: 0.25
          type: number
          nullable: true
        semidetachedHouse:
          title: Semidetachedhouse
          description: Average energy usage of semidetached houses
          example: 0.25
          type: number
          nullable: true
        terracedHouse:
          title: Terracedhouse
          description: Average energy usage of terraced houses
          example: 0.25
          type: number
          nullable: true
      type: object
      required:
      - apartment
      - average
      - cornerHouse
      - detachedHouse
      - ownedHomes
      - rentalHomes
      - semidetachedHouse
      - terracedHouse
      title: EnergyUsage
    EnvironmentalPermit:
      properties:
        houseExtension:
          description: Permit costs for a house extension
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        newConstruction:
          description: Permit costs for new construction
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        dormer:
          description: Permit costs for a dormer
          allOf:
          - $ref: '#/components/schemas/EuroObject'
      type: object
      required:
      - houseExtension
      - newConstruction
      - dormer
      title: EnvironmentalPermit
    Erfpachtcanon:
      properties:
        einddatumAfkoop:
          title: Einddatumafkoop
          type: string
          nullable: true
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        indicatieOudeOnroerendeZaakBetrokken:
          title: Indicatieoudeonroerendezaakbetrokken
          type: boolean
          nullable: true
        jaarlijksBedrag:
          allOf:
          - $ref: '#/components/schemas/JaarlijksBedrag'
          nullable: true
        soort:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        betreft:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isGebaseerdOp:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
      type: object
      title: Erfpachtcanon
    ErrorResponseModel:
      properties:
        error:
          $ref: '#/components/schemas/ErrorObject'
      type: object
      required:
      - error
      title: ErrorResponseModel
    EuroObject:
      properties:
        mutation:
          title: Mutation
          description: Mutation as compared to last year
          example: 5.5
          type: number
          nullable: true
        euro:
          title: Euro
          description: "Price or amount in EUR (\u20AC)"
          example: 123
          type: number
          nullable: true
        comment:
          title: Comment
          description: Comment
          type: string
          nullable: true
      type: object
      required:
      - mutation
      - euro
      - comment
      title: EuroObject
    Fees:
      properties:
        driversLicence:
          description: Costs of a driver's license
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        passport:
          description: Costs of a passport
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        identityCard:
          description: Costs of an ID card
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        extractMunicipalPersonalRecordsDatabase:
          description: Costs of an official BRP excerpt
          allOf:
          - $ref: '#/components/schemas/EuroObject'
      type: object
      required:
      - driversLicence
      - passport
      - identityCard
      - extractMunicipalPersonalRecordsDatabase
      title: Fees
    Geboorte:
      properties:
        geboortedatum:
          allOf:
          - $ref: '#/components/schemas/TypeOnvolledigeDatum'
          nullable: true
        geboorteland:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        geboorteplaats:
          title: Geboorteplaats
          type: string
          maxLength: 80
          minLength: 1
          nullable: true
      type: object
      title: Geboorte
    GeregistreerdPersoon:
      properties:
        adellijkeTitelOfPredikaat:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        bsn:
          title: Bsn
          type: string
          maxLength: 9
          pattern: ([0][0-9]{8})|([1-9][0-9]{7,8})
          nullable: true
        geboorte:
          allOf:
          - $ref: '#/components/schemas/Geboorte'
          nullable: true
        geslacht:
          allOf:
          - $ref: '#/components/schemas/Geslacht'
          nullable: true
        inOnderzoek:
          title: Inonderzoek
          type: boolean
          nullable: true
        naam:
          allOf:
          - $ref: '#/components/schemas/Naam'
          nullable: true
        overlijden:
          allOf:
          - $ref: '#/components/schemas/Overlijden'
          nullable: true
      type: object
      required:
      - bsn
      title: GeregistreerdPersoon
    Geslacht:
      properties:
        geslachtsaanduiding:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
      type: object
      title: Geslacht
    GetalveldmetbronModel:
      properties:
        waarde:
          title: Waarde
          type: integer
          nullable: true
        bron:
          title: Bron
          type: string
          nullable: true
      type: object
      title: GetalveldmetbronModel
    GezamenlijkAandeel:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        aandeel:
          allOf:
          - $ref: '#/components/schemas/TypeBreuk'
          nullable: true
      type: object
      title: GezamenlijkAandeel
    Herverkavelingsgebied:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        statusHerverkavelingsproject:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
      type: object
      title: Herverkavelingsgebied
    HouseDetailResponse:
      properties:
        houseType:
          type: string
          title: Housetype
          description: Type of dwelling.
          example: 2-onder-1-kapwoning
        buildYear:
          type: integer
          title: Buildyear
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
        useSurface:
          type: integer
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 104
        parcelSurface:
          type: integer
          title: Parcelsurface
          description: The lot/parcel surface in m2.
          example: 338
      type: object
      required:
      - houseType
      - buildYear
      - useSurface
      - parcelSurface
      title: HouseDetailResponse
    Households:
      properties:
        multiPersonHousehold:
          description: Taxes paid for a multi person household
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        singlePersonHousehold:
          description: Taxes paid for a single person household
          allOf:
          - $ref: '#/components/schemas/EuroObject'
      type: object
      required:
      - multiPersonHousehold
      - singlePersonHousehold
      title: Households
    HousingCosts:
      properties:
        housingCosts:
          description: Housing costs
          allOf:
          - $ref: '#/components/schemas/Households'
        taxCredit:
          description: Tax credit
          allOf:
          - $ref: '#/components/schemas/TaxCredit'
      type: object
      required:
      - housingCosts
      - taxCredit
      title: HousingCosts
    JaarlijksBedrag:
      properties:
        bedrag:
          allOf:
          - $ref: '#/components/schemas/Bedrag'
          nullable: true
        betreftMeerOnroerendeZaken:
          title: Betreftmeeronroerendezaken
          type: boolean
          nullable: true
      type: object
      title: JaarlijksBedrag
    Kadasterstuk:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: Kadasterstuk
        toelichtingBewaarder:
          title: Toelichtingbewaarder
          type: string
          nullable: true
        omvat:
          title: Omvat
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
        portefeuillenummer:
          allOf:
          - $ref: '#/components/schemas/PortefeuilleId'
          nullable: true
      type: object
      title: Kadasterstuk
    KenmerkenModel:
      properties:
        bouwjaar:
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 2020
          allOf:
          - $ref: '#/components/schemas/GetalveldmetbronModel'
        perceelopp:
          description: The lot/parcel surface in m2.
          example: 338
          allOf:
          - $ref: '#/components/schemas/GetalveldmetbronModel'
        woningtype:
          description: Dwelling type
          example: 2-onder-1-kapwoning
          allOf:
          - $ref: '#/components/schemas/TekstveldmetbronModel'
        woonopp:
          description: The usable surface area of a property object in square meters.
          example: 104
          allOf:
          - $ref: '#/components/schemas/GetalveldmetbronModel'
        vooraanzichtfoto:
          description: Front view image url
          allOf:
          - $ref: '#/components/schemas/BestandModel'
      type: object
      required:
      - bouwjaar
      - perceelopp
      - woningtype
      - woonopp
      - vooraanzichtfoto
      title: KenmerkenModel
    LeadtoolReferenceModel:
      properties:
        amount:
          type: integer
          title: Amount
        city:
          type: string
          title: City
          description: City
          example: Laren
        date:
          type: string
          format: date
          title: Date
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        latitude:
          type: number
          title: Latitude
          description: Latitude
          example: 52.25291881
        longitude:
          type: number
          title: Longitude
          description: Longitude
          example: 5.23903348
        postalCode:
          type: string
          title: Postalcode
          description: Postal code
          example: 1251NJ
        street:
          type: string
          title: Street
          description: Street name
          example: Graafland
        useSurface:
          type: integer
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 104
      type: object
      required:
      - amount
      - city
      - date
      - houseNumber
      - latitude
      - longitude
      - postalCode
      - street
      - useSurface
      title: LeadtoolReferenceModel
    LocatieKadastraalObject:
      properties:
        koppelingswijze:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        betreft:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        heeft:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: LocatieKadastraalObject
    Location:
      properties:
        x:
          type: number
          title: X
          example: 144882.297
        y:
          type: number
          title: Y
          example: 473885.719
      type: object
      required:
      - x
      - y
      title: Location
    Mandeligheid:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isGebaseerdOp:
          title: Isgebaseerdop
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
        heeftHoofdzaak:
          title: Heefthoofdzaak
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
      type: object
      title: Mandeligheid
    ModelwaardeModel:
      properties:
        type:
          type: string
          title: Type
        waarde:
          type: integer
          title: Waarde
        nauwkeurigheidsindicator:
          type: integer
          title: Nauwkeurigheidsindicator
        nauwkeurigheidsintervallaag:
          type: integer
          title: Nauwkeurigheidsintervallaag
        nauwkeurigheidsintervalhoog:
          type: integer
          title: Nauwkeurigheidsintervalhoog
      type: object
      required:
      - type
      - waarde
      - nauwkeurigheidsindicator
      - nauwkeurigheidsintervallaag
      - nauwkeurigheidsintervalhoog
      title: ModelwaardeModel
    ModelwaardedataModel:
      properties:
        modelwaarden:
          items:
            $ref: '#/components/schemas/ModelwaardeModel'
          type: array
          title: Modelwaarden
        peildatum:
          type: string
          format: date
          title: Peildatum
      type: object
      required:
      - modelwaarden
      - peildatum
      title: ModelwaardedataModel
    MunicipalTaxes:
      properties:
        fees:
          description: Other fees
          allOf:
          - $ref: '#/components/schemas/Fees'
        touristTax:
          description: Tourist Tax
          allOf:
          - $ref: '#/components/schemas/EuroObject'
        wasteCollectionCharge:
          description: Waste collection charge
          allOf:
          - $ref: '#/components/schemas/Households'
        environmentalPermit:
          description: Environmental permit
          allOf:
          - $ref: '#/components/schemas/EnvironmentalPermit'
        sewerCharge:
          description: Sewer charge
          allOf:
          - $ref: '#/components/schemas/SewerCharge'
        parkingTax:
          title: Parkingtax
          description: Parking tax
          example: 123
          type: integer
          nullable: true
        housingCosts:
          description: Housing costs
          allOf:
          - $ref: '#/components/schemas/HousingCosts'
        propertyTax:
          description: Property tax
          allOf:
          - $ref: '#/components/schemas/PropertyTax'
        dogTax:
          description: Dog tax
          allOf:
          - $ref: '#/components/schemas/EuroObject'
      type: object
      required:
      - fees
      - touristTax
      - wasteCollectionCharge
      - environmentalPermit
      - sewerCharge
      - housingCosts
      - propertyTax
      - dogTax
      title: MunicipalTaxes
    NEN3610ID:
      properties:
        lokaalID:
          type: string
          title: Lokaalid
        namespace:
          type: string
          title: Namespace
      type: object
      required:
      - lokaalID
      - namespace
      title: NEN3610ID
    Naam:
      properties:
        geslachtsnaam:
          title: Geslachtsnaam
          type: string
          maxLength: 200
          minLength: 1
          nullable: true
        voornamen:
          title: Voornamen
          type: string
          maxLength: 200
          minLength: 1
          nullable: true
        voorvoegselsgeslachtsnaam:
          title: Voorvoegselsgeslachtsnaam
          type: string
          maxLength: 10
          minLength: 1
          nullable: true
      type: object
      title: Naam
    NatuurlijkPersoon:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: NatuurlijkPersoon
        beschikkingsbevoegdheid:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        indicatieNietToonbareDiakriet:
          title: Indicatieniettoonbarediakriet
          type: boolean
          nullable: true
        postlocatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        woonlocatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isRechthebbendeVan:
          title: Isrechthebbendevan
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isBetrokkeneBij:
          title: Isbetrokkenebij
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        indicatieOverleden:
          title: Indicatieoverleden
          type: boolean
          nullable: true
        betreft:
          allOf:
          - $ref: '#/components/schemas/GeregistreerdPersoon'
          nullable: true
      type: object
      title: NatuurlijkPersoon
    NietNatuurlijkPersoon:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: NietNatuurlijkPersoon
        beschikkingsbevoegdheid:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        indicatieNietToonbareDiakriet:
          title: Indicatieniettoonbarediakriet
          type: boolean
          nullable: true
        postlocatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        woonlocatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isRechthebbendeVan:
          title: Isrechthebbendevan
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isBetrokkeneBij:
          title: Isbetrokkenebij
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        rechtsvorm:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        statutaireNaam:
          title: Statutairenaam
          type: string
          maxLength: 200
          minLength: 1
          nullable: true
        statutaireZetel:
          title: Statutairezetel
          type: string
          maxLength: 40
          minLength: 1
          nullable: true
        betreft:
          allOf:
          - $ref: '#/components/schemas/Rechtspersoon'
          nullable: true
      type: object
      title: NietNatuurlijkPersoon
    NumberDesignation:
      properties:
        beginDate:
          type: string
          title: Begindate
          description: Beginning date
          example: '1954-12-24T00:00:00+00:00'
        documentDate:
          type: string
          title: Documentdate
          description: Date of document
          example: '1954-12-24T00:00:00+00:00'
        documentNumber:
          type: string
          title: Documentnumber
          description: Number of the document
          example: L3286
        houseLetter:
          title: Houseletter
          description: House letter
          example: null
          type: string
          nullable: true
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseNumberExtension:
          title: Housenumberextension
          description: House number extention
          example: null
          type: string
          nullable: true
        id:
          type: string
          title: Id
          description: Identification
          example: 0417200000001419
        mutationDate:
          title: Mutationdate
          description: Mutation date
          example: null
          type: string
          nullable: true
        noted:
          type: boolean
          title: Noted
          description: Any information that was stated
          example: false
        objectType:
          type: string
          title: Objecttype
          description: Type of the object
          example: Verblijfsobject
        postcode:
          type: string
          title: Postcode
          description: Zipcode
          example: 1251NJ
        relatedPublicSpace:
          type: string
          title: Relatedpublicspace
          description: Number of the public space it is related to.
          example: '0417300000000061'
        status:
          type: string
          title: Status
          description: Status of the number designated.
          example: Naamgeving uitgegeven
      type: object
      required:
      - beginDate
      - documentDate
      - documentNumber
      - houseNumber
      - id
      - noted
      - objectType
      - postcode
      - relatedPublicSpace
      - status
      title: NumberDesignation
    Nummeraanduiding:
      properties:
        huisletter:
          title: Huisletter
          type: string
          maxLength: 1
          pattern: '[a-zA-Z]'
          nullable: true
        huisnummer:
          title: Huisnummer
          type: integer
          nullable: true
        huisnummertoevoeging:
          title: Huisnummertoevoeging
          type: string
          maxLength: 4
          minLength: 1
          pattern: ([a-z,A-Z,0-9])+
          nullable: true
        identificatie:
          title: Identificatie
          type: string
          nullable: true
        postcode:
          title: Postcode
          type: string
          maxLength: 6
          pattern: '[1-9][0-9][0-9][0-9][A-Z][A-Z]'
          nullable: true
        gerelateerdeOpenbareRuimte:
          allOf:
          - $ref: '#/components/schemas/OpenbareRuimte'
          nullable: true
        gerelateerdeWoonplaatsNaam:
          title: Gerelateerdewoonplaatsnaam
          type: string
          maxLength: 80
          minLength: 1
          nullable: true
      type: object
      title: Nummeraanduiding
    Object:
      properties:
        beginDate:
          type: string
          title: Begindate
          description: Beginning date
          example: '2018-12-06T00:00:00+00:00'
        documentDate:
          type: string
          title: Documentdate
          description: Date of the document.
          example: '2018-12-06T00:00:00+00:00'
        documentNumber:
          type: string
          title: Documentnumber
          description: Number of the document
          example: 2018-0887
        id:
          type: string
          title: Id
          description: Identification
          example: 0417010001001419
        location:
          description: Location
          allOf:
          - $ref: '#/components/schemas/Location'
        mutationDate:
          title: Mutationdate
          description: Mutation date
          example: null
          type: string
          nullable: true
        noted:
          type: boolean
          title: Noted
          description: Any information that was stated
          example: false
        relatedBuilding:
          type: string
          title: Relatedbuilding
          description: Number of the building it is related to
          example: 0417100000005928
        relatedMainAddress:
          type: string
          title: Relatedmainaddress
          description: Number of the address it is related to
          example: 0417200000001419
        status:
          type: string
          title: Status
          description: Status of the object.
          example: Verblijfsobject in gebruik
        usePurpose:
          type: string
          title: Usepurpose
          description: Use function of the building
          example: woonfunctie
        useSurface:
          type: integer
          title: Usesurface
          description: Use surface of the building
          example: 131
      type: object
      required:
      - beginDate
      - documentDate
      - documentNumber
      - id
      - location
      - noted
      - relatedBuilding
      - relatedMainAddress
      - status
      - usePurpose
      - useSurface
      title: Object
    ObjectReferentie:
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/ObjectReferentieType'
          nullable: true
        domein:
          title: Domein
          type: string
          nullable: true
        identificatieReferentie:
          title: Identificatiereferentie
          type: string
          nullable: true
      type: object
      title: ObjectReferentie
    ObjectReferentieType:
      type: string
      enum:
      - BAG
      - BGT
      title: ObjectReferentieType
    ObjectlocatieBinnenland:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: ObjectlocatieBinnenland
        nummeraanduiding:
          allOf:
          - $ref: '#/components/schemas/Nummeraanduiding'
          nullable: true
      type: object
      title: ObjectlocatieBinnenland
    ObjectlocatieBuitenland:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: ObjectlocatieBuitenland
        adresBuitenland:
          allOf:
          - $ref: '#/components/schemas/AdresBuitenland'
          nullable: true
      type: object
      title: ObjectlocatieBuitenland
    OmgevingsinformatieItem:
      properties:
        buurtnaam:
          type: string
          title: Buurtnaam
          description: Name of the neighbourhood
          example: Zevenend
        buurtcode:
          type: string
          title: Buurtcode
          description: Code of the neighbourhood
          example: BU04170328
        buurt_woz_gemiddeld:
          type: integer
          title: Buurt Woz Gemiddeld
          description: Neighbourhood WOZ average
          example: 575000
        gemeente_ozb_woningen:
          type: number
          title: Gemeente Ozb Woningen
          description: Municipality real estate tax (OZB) objects
          example: 0.0942
        gemeente_reiniging_eenpers:
          type: integer
          title: Gemeente Reiniging Eenpers
          description: ''
          example: 285
        gemeente_reiniging_meerpers:
          type: integer
          title: Gemeente Reiniging Meerpers
          description: ''
          example: 419
        gemeente_riool_eenpers:
          type: integer
          title: Gemeente Riool Eenpers
          description: ''
          example: 180
        gemeente_riool_meerpers:
          type: integer
          title: Gemeente Riool Meerpers
          description: ''
          example: 309
        buurt_lftd_tot_vijftien:
          type: integer
          title: Buurt Lftd Tot Vijftien
          description: ''
          example: 765
        buurt_lftd_tot_vijftwintig:
          type: integer
          title: Buurt Lftd Tot Vijftwintig
          description: ''
          example: 410
        buurt_lftd_tot_vijfveertig:
          type: integer
          title: Buurt Lftd Tot Vijfveertig
          description: ''
          example: 785
        buurt_lftd_tot_vijfzestig:
          type: integer
          title: Buurt Lftd Tot Vijfzestig
          description: ''
          example: 1275
        buurt_lftd_ouder:
          type: integer
          title: Buurt Lftd Ouder
          description: ''
          example: 1365
        buurt_perc_lftd_tot_vijftien:
          type: integer
          title: Buurt Perc Lftd Tot Vijftien
          description: ''
          example: 17
        buurt_perc_lftd_tot_vijftwintig:
          type: integer
          title: Buurt Perc Lftd Tot Vijftwintig
          description: ''
          example: 9
        buurt_perc_lftd_tot_vijfveertig:
          type: integer
          title: Buurt Perc Lftd Tot Vijfveertig
          description: ''
          example: 17
        buurt_perc_lftd_tot_vijfzestig:
          type: integer
          title: Buurt Perc Lftd Tot Vijfzestig
          description: ''
          example: 28
        buurt_perc_lftd_ouder:
          type: integer
          title: Buurt Perc Lftd Ouder
          description: ''
          example: 30
        buurt_aantal_hh:
          type: integer
          title: Buurt Aantal Hh
          description: ''
          example: 2160
        buurt_gem_grootte_hh:
          type: number
          title: Buurt Gem Grootte Hh
          description: ''
          example: 2.1
        buurt_hh_eenpersoon:
          type: integer
          title: Buurt Hh Eenpersoon
          description: ''
          example: 855
        buurt_hh_geen_kind:
          type: integer
          title: Buurt Hh Geen Kind
          description: ''
          example: 610
        buurt_hh_met_kind:
          type: integer
          title: Buurt Hh Met Kind
          description: ''
          example: 695
        buurt_perc_hh_eenpersoon:
          type: integer
          title: Buurt Perc Hh Eenpersoon
          description: ''
          example: 40
        buurt_perc_hh_geen_kind:
          type: integer
          title: Buurt Perc Hh Geen Kind
          description: ''
          example: 28
        buurt_perc_hh_met_kind:
          type: integer
          title: Buurt Perc Hh Met Kind
          description: ''
          example: 32
        buurt_gem_elek_woning:
          type: integer
          title: Buurt Gem Elek Woning
          description: ''
          example: 3160
        buurt_afstand_huisartsprak:
          type: number
          title: Buurt Afstand Huisartsprak
          description: ''
          example: 0.8
        buurt_afstand_apotheek:
          type: number
          title: Buurt Afstand Apotheek
          description: ''
          example: 0.7
        buurt_afstand_ziekenhuis_inclpoli:
          type: number
          title: Buurt Afstand Ziekenhuis Inclpoli
          description: ''
          example: 2.9
        buurt_afstand_ziekenhuis_exclpoli:
          type: number
          title: Buurt Afstand Ziekenhuis Exclpoli
          description: ''
          example: 2.9
        buurt_perc_appartement:
          title: Buurt Perc Appartement
          description: ''
          example: 16
          type: integer
          nullable: true
        buurt_aantal_woningen:
          title: Buurt Aantal Woningen
          type: integer
          nullable: true
        buurt_aantal_vrijstaand:
          title: Buurt Aantal Vrijstaand
          type: integer
          nullable: true
        buurt_aantal_onderkap:
          title: Buurt Aantal Onderkap
          type: integer
          nullable: true
        buurt_aantal_hoek:
          title: Buurt Aantal Hoek
          type: integer
          nullable: true
        buurt_aantal_tussen:
          title: Buurt Aantal Tussen
          type: integer
          nullable: true
        buurt_aantal_appartement:
          title: Buurt Aantal Appartement
          type: integer
          nullable: true
        buurt_aantal_woning_overig:
          title: Buurt Aantal Woning Overig
          type: integer
          nullable: true
        buurt_perc_vrijstaand:
          title: Buurt Perc Vrijstaand
          type: number
          nullable: true
        buurt_perc_onderkap:
          title: Buurt Perc Onderkap
          type: number
          nullable: true
        buurt_perc_hoek:
          title: Buurt Perc Hoek
          type: number
          nullable: true
        buurt_perc_tussen:
          title: Buurt Perc Tussen
          type: number
          nullable: true
        buurt_perc_woning_overig:
          title: Buurt Perc Woning Overig
          type: number
          nullable: true
        gemeente_water_koop:
          title: Gemeente Water Koop
          type: integer
          nullable: true
        gemeente_water_huur:
          title: Gemeente Water Huur
          type: integer
          nullable: true
      type: object
      required:
      - buurtnaam
      - buurtcode
      - buurt_woz_gemiddeld
      - gemeente_ozb_woningen
      - gemeente_reiniging_eenpers
      - gemeente_reiniging_meerpers
      - gemeente_riool_eenpers
      - gemeente_riool_meerpers
      - buurt_lftd_tot_vijftien
      - buurt_lftd_tot_vijftwintig
      - buurt_lftd_tot_vijfveertig
      - buurt_lftd_tot_vijfzestig
      - buurt_lftd_ouder
      - buurt_perc_lftd_tot_vijftien
      - buurt_perc_lftd_tot_vijftwintig
      - buurt_perc_lftd_tot_vijfveertig
      - buurt_perc_lftd_tot_vijfzestig
      - buurt_perc_lftd_ouder
      - buurt_aantal_hh
      - buurt_gem_grootte_hh
      - buurt_hh_eenpersoon
      - buurt_hh_geen_kind
      - buurt_hh_met_kind
      - buurt_perc_hh_eenpersoon
      - buurt_perc_hh_geen_kind
      - buurt_perc_hh_met_kind
      - buurt_gem_elek_woning
      - buurt_afstand_huisartsprak
      - buurt_afstand_apotheek
      - buurt_afstand_ziekenhuis_inclpoli
      - buurt_afstand_ziekenhuis_exclpoli
      title: OmgevingsinformatieItem
    OnroerendeZaakBeperking:
      properties:
        inOnderzoek:
          title: Inonderzoek
          type: boolean
          nullable: true
        beperkt:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: OnroerendeZaakBeperking
    OnroerendeZaakFiliatie:
      properties:
        betreftOZ:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: OnroerendeZaakFiliatie
    OnroerendeZaakTypeEnum:
      type: string
      enum:
      - Perceel
      - Appartementsrecht
      - Leidingnetwerk
      title: OnroerendeZaakTypeEnum
    OpenbareRuimte:
      properties:
        openbareRuimteNaam:
          title: Openbareruimtenaam
          type: string
          maxLength: 80
          minLength: 1
          nullable: true
        gerelateerdeWoonplaatsNaam:
          title: Gerelateerdewoonplaatsnaam
          type: string
          maxLength: 80
          minLength: 1
          nullable: true
      type: object
      title: OpenbareRuimte
    Overlijden:
      properties:
        datumOverlijden:
          allOf:
          - $ref: '#/components/schemas/TypeOnvolledigeDatum'
          nullable: true
      type: object
      title: Overlijden
    Perceel:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          allOf:
          - $ref: '#/components/schemas/OnroerendeZaakTypeEnum'
          nullable: true
        aardCultuurBebouwd:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        aardCultuurOnbebouwd:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        heeftMeerAdressen:
          title: Heeftmeeradressen
          type: boolean
          nullable: true
        kadastraleAanduiding:
          allOf:
          - $ref: '#/components/schemas/TypeKadastraleAanduiding'
          nullable: true
        koopsom:
          allOf:
          - $ref: '#/components/schemas/TypeKoopsom'
          nullable: true
        landinrichtingsrente:
          title: Landinrichtingsrente
          items:
            $ref: '#/components/schemas/TypeLandinrichtingsrente'
          type: array
          minItems: 0
          nullable: true
        toelichtingBewaarder:
          title: Toelichtingbewaarder
          type: string
          nullable: true
        ontstaanUitOZ:
          title: Ontstaanuitoz
          items:
            $ref: '#/components/schemas/OnroerendeZaakFiliatie'
          type: array
          minItems: 0
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        overgegaanIn:
          title: Overgegaanin
          items:
            $ref: '#/components/schemas/VoorwaartseOnroerendeZaakFiliatie'
          type: array
          nullable: true
        kadastraleGrootte:
          allOf:
          - $ref: '#/components/schemas/TypeOppervlak'
          nullable: true
        indicatieMeettariefVerschuldigd:
          title: Indicatiemeettariefverschuldigd
          type: boolean
          nullable: true
        plaatscoordinaten:
          allOf:
          - $ref: '#/components/schemas/PointGeoJSON'
          nullable: true
      type: object
      title: Perceel
    PercentageObject:
      properties:
        mutation:
          title: Mutation
          description: Mutation as compared to last year
          example: 5.5
          type: number
          nullable: true
        percentage:
          title: Percentage
          description: Rate (%)
          example: 0.25
          type: number
          nullable: true
        comment:
          title: Comment
          description: Comment
          type: string
          nullable: true
      type: object
      required:
      - mutation
      - percentage
      - comment
      title: PercentageObject
    Place:
      properties:
        beginDate:
          type: string
          title: Begindate
          description: Beginning date
          example: '2009-03-25T00:00:00+00:00'
        documentDate:
          type: string
          title: Documentdate
          description: Date of the document
          example: '2009-03-25T00:00:00+00:00'
        documentNumber:
          type: string
          title: Documentnumber
          description: Number of the document
          example: '200911'
        id:
          type: string
          title: Id
          description: Identification
          example: '2890'
        mutationDate:
          title: Mutationdate
          description: Mutation date
          example: null
          type: string
          nullable: true
        name:
          type: string
          title: Name
          description: Name of the place
          example: Laren
        noted:
          type: boolean
          title: Noted
          description: Any information that was stated
          example: false
        status:
          type: string
          title: Status
          description: Status of the place
          example: Woonplaats aangewezen
      type: object
      required:
      - beginDate
      - documentDate
      - documentNumber
      - id
      - name
      - noted
      - status
      title: Place
    PointGeoJSON:
      properties:
        type:
          $ref: '#/components/schemas/Type'
        coordinates:
          items:
            type: number
          type: array
          minItems: 2
          title: Coordinates
      type: object
      required:
      - type
      - coordinates
      title: PointGeoJSON
    PortefeuilleId:
      properties:
        akrRegistercode:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        akrStukdeel1:
          title: Akrstukdeel1
          type: string
          nullable: true
        akrStukdeel2:
          title: Akrstukdeel2
          type: string
          nullable: true
        akrStukdeel3:
          title: Akrstukdeel3
          type: string
          nullable: true
        volgnummerStaat75:
          title: Volgnummerstaat75
          type: integer
          nullable: true
      type: object
      title: PortefeuilleId
    PostbusLocatie:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: PostbusLocatie
        postbusnummer:
          title: Postbusnummer
          type: integer
          nullable: true
        postcode:
          allOf:
          - $ref: '#/components/schemas/TypePostcode'
          nullable: true
        woonplaatsNaam:
          title: Woonplaatsnaam
          type: string
          maxLength: 80
          minLength: 1
          nullable: true
      type: object
      title: PostbusLocatie
    PrijsModel:
      properties:
        prijs:
          $ref: '#/components/schemas/GetalveldmetbronModel'
        datum:
          $ref: '#/components/schemas/TekstveldmetbronModel'
        geindexeerde_prijs:
          $ref: '#/components/schemas/GetalveldmetbronModel'
      type: object
      required:
      - prijs
      - datum
      - geindexeerde_prijs
      title: PrijsModel
    PropertyTax:
      properties:
        rate:
          description: Rate of property tax
          allOf:
          - $ref: '#/components/schemas/Rate'
        residentialAverage:
          description: Residential Average of property tax
          allOf:
          - $ref: '#/components/schemas/EuroObject'
      type: object
      required:
      - rate
      - residentialAverage
      title: PropertyTax
    PublicSpace:
      properties:
        beginDate:
          type: string
          title: Begindate
          description: Beginning date
          example: '2010-09-28T00:00:00+00:00'
        documentDate:
          type: string
          title: Documentdate
          description: Date of the document
          example: '2010-09-28T00:00:00+00:00'
        documentNumber:
          type: string
          title: Documentnumber
          description: Number of the document
          example: -2.07.155.2
        id:
          type: string
          title: Id
          description: Identification
          example: '0417300000000061'
        mutationDate:
          title: Mutationdate
          description: Mutation date
          example: null
          type: string
          nullable: true
        name:
          type: string
          title: Name
          description: Name of the public space
          example: Graafland
        noted:
          type: boolean
          title: Noted
          description: Any information that was stated
          example: false
        relatedPlace:
          type: string
          title: Relatedplace
          description: Number of the place it is related to
          example: '2890'
        status:
          type: string
          title: Status
          description: Status of the public space
          example: Naamgeving uitgegeven
      type: object
      required:
      - beginDate
      - documentDate
      - documentNumber
      - id
      - name
      - noted
      - relatedPlace
      - status
      title: PublicSpace
    PubliekrechtelijkeBeperking:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        datumBeeindiging:
          title: Datumbeeindiging
          type: string
          nullable: true
        datumInWerking:
          title: Datuminwerking
          type: string
          nullable: true
        grondslag:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        isGebaseerdOp:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
        leidtTot:
          title: Leidttot
          items:
            $ref: '#/components/schemas/OnroerendeZaakBeperking'
          type: array
          nullable: true
        bevoegdGezag:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        heeft:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: PubliekrechtelijkeBeperking
    Rate:
      properties:
        residential:
          description: Taxes paid on residential real estate in proportion to real
            estate value.
          allOf:
          - $ref: '#/components/schemas/PercentageObject'
        nonresidential:
          description: Taxes paid on non-residential real estate in proportion to
            real estate value.
          allOf:
          - $ref: '#/components/schemas/PercentageObject'
      type: object
      required:
      - residential
      - nonresidential
      title: Rate
    RechtenItem:
      properties:
        aandeel:
          title: Aandeel
          description: The share someone is entitled to
          example: 1/2
          type: string
          nullable: true
        aanvullendeStukken:
          items:
            $ref: '#/components/schemas/AanvullendeStukkenItem'
          type: array
          title: Aanvullendestukken
          description: Array of additional documents
        adres:
          title: Adres
          description: The address of the (not natural) person
          example: Provincialeweg 57, 5398 JJ Maren-Kessel
          type: string
          nullable: true
        afkomstigUitStukken:
          items:
            $ref: '#/components/schemas/AfkomstigUitStukkenItem'
          type: array
          title: Afkomstiguitstukken
          description: Array of originating documents
        betrokkenPersoon:
          title: Betrokkenpersoon
          description: A person that is attracted to the right
          example: Jan Janssen
          type: string
          nullable: true
        burgerlijkeStaat:
          title: Burgerlijkestaat
          description: Marital status of the person
          example: Ongehuwd en geen geregistreerd partnerschap (ten tijde van verkrijging)
          type: string
          nullable: true
        geboortedatum:
          title: Geboortedatum
          description: Date of birth of the (not natural) person
          example: 29-08-2025
          type: string
          nullable: true
        geboorteplaats:
          title: Geboorteplaats
          description: Place of birth of the (not natural) person
          example: Amsterdam
          type: string
          nullable: true
        kvkNummer:
          title: Kvknummer
          description: Chamber of Commerce number
          example: '12345678'
          type: string
          nullable: true
        naamGerechtigde:
          title: Naamgerechtigde
          description: The name of the (not natural) person
          example: Jan Janssen
          type: string
          nullable: true
        postAdres:
          title: Postadres
          description: The postal address of the (not natural) person
          example: Postbus 1, 1000 AA Amsterdam
          type: string
          nullable: true
        rechtenCijfer:
          title: Rechtencijfer
          description: The digits that represent the right
          example: 1.1 Zakelijk recht als bedoeld in artikel 5, lid 3, onder b, van
            de Belemmeringenwet
          type: string
          nullable: true
        soortRecht:
          title: Soortrecht
          description: The type of right
          example: Eigendom (recht van)
          type: string
          nullable: true
        statutaireZetel:
          title: Statutairezetel
          description: Name of registered office
          example: Amsterdam
          type: string
          nullable: true
        vermeldInStukken:
          items:
            $ref: '#/components/schemas/VermeldInStukkenItem'
          type: array
          title: Vermeldinstukken
          description: Array of documents this deed is mentioned in
      type: object
      required:
      - aanvullendeStukken
      - afkomstigUitStukken
      - vermeldInStukken
      title: RechtenItem
    Rechtspersoon:
      properties:
        kvkNummer:
          title: Kvknummer
          type: string
          maxLength: 8
          nullable: true
      type: object
      title: Rechtspersoon
    ReferenceObjectModel:
      properties:
        amount:
          type: integer
          title: Amount
        bagId:
          type: string
          title: Bagid
          description: Identification number according to the BAG.
          example: 0417200000001419
        buildType:
          type: string
          title: Buildtype
          description: Dwelling type
          example: 2-onder-1-kapwoning
        buildYear:
          type: integer
          title: Buildyear
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
        buildYearCat:
          title: Buildyearcat
          type: string
          nullable: true
        city:
          type: string
          title: City
          description: City
          example: Laren
        date:
          type: string
          format: date
          title: Date
        distance:
          type: number
          title: Distance
          description: Distance of the reference object from the valuation object
            in meter.
          example: 200
        equality:
          title: Equality
          type: number
          nullable: true
        houseNumber:
          type: integer
          title: Housenumber
          description: House number
          example: 22
        houseNumberExt:
          title: Housenumberext
          description: House number extention
          example: null
          type: string
          nullable: true
        indexedPrice:
          title: Indexedprice
          type: integer
          nullable: true
        monument:
          title: Monument
          description: Boolean indicating whether the house is a monument.
          example: false
          type: boolean
          nullable: true
        parcelSurface:
          title: Parcelsurface
          description: The lot/parcel surface in m2.
          example: 338
          type: integer
          nullable: true
        postalCode:
          type: string
          title: Postalcode
          description: Zipcode
          example: 1251NJ
        state:
          type: string
          title: State
          description: State
          example: Noord-Holland
        street:
          type: string
          title: Street
          description: Street name
          example: Graafland
        useSurface:
          type: integer
          title: Usesurface
          description: The usable surface area of a property object in square meters.
          example: 104
        volume:
          title: Volume
          description: Volume in m3.
          example: 411
          type: integer
          nullable: true
      type: object
      required:
      - amount
      - bagId
      - buildType
      - buildYear
      - city
      - date
      - distance
      - houseNumber
      - postalCode
      - state
      - street
      - useSurface
      title: ReferenceObjectModel
    ReferenceObjectsResponse:
      properties:
        address:
          description: Address
          allOf:
          - $ref: '#/components/schemas/AddressResponse'
        houseDetails:
          description: House/Object details
          allOf:
          - $ref: '#/components/schemas/HouseDetailResponse'
        wozValue:
          type: integer
          title: Wozvalue
          description: Woz Value
          example: 800000
        referenceScore:
          type: number
          title: Referencescore
          description: Reference score
          example: 99.84
      type: object
      required:
      - address
      - houseDetails
      - wozValue
      - referenceScore
      title: ReferenceObjectsResponse
    ReferenceResponse:
      properties:
        index_nr:
          type: integer
          title: Index Nr
          description: Index number
          example: 1
        number_id:
          type: string
          title: Number Id
          description: Identification number according to the BAG.
          example: 0417200000001419
        street_name:
          type: string
          title: Street Name
          description: Street name
          example: Graafland
        postal_code:
          type: string
          title: Postal Code
          description: Postal code
          example: 1251NJ
        house_number:
          type: integer
          title: House Number
          description: House number
          example: 22
        house_letter:
          title: House Letter
          description: House letter
          example: null
          type: string
          nullable: true
        house_number_ext:
          title: House Number Ext
          description: House number extention
          example: null
          type: string
          nullable: true
        city_name:
          type: string
          title: City Name
          description: City
          example: Laren
        municipality_name:
          type: string
          title: Municipality Name
          description: Municipality
          example: Laren (NH.)
        province_name:
          type: string
          title: Province Name
          description: Province
          example: Noord-Holland
        latitude:
          type: number
          title: Latitude
          description: Latitude
          example: 52.25291881
        longitude:
          type: number
          title: Longitude
          description: Longitude
          example: 5.23903348
        distance:
          type: number
          title: Distance
          description: Distance of the reference object from the valuation object
            in meter.
          example: 200
        house_type:
          type: string
          title: House Type
          description: Dwelling type
          example: 2-onder-1-kapwoning
        build_year:
          type: integer
          title: Build Year
          description: Indication of the year in which the building will originally
            be delivered in, or is architectually ready. Also known as construction
            year.
          example: 1955
        use_surface:
          type: integer
          title: Use Surface
          description: The usable surface area of a property object in square meters.
          example: 104
        use_surface_bag:
          title: Use Surface Bag
          description: The usable surface area of a property object in square meters
            according to the BAG.
          example: 104
          type: integer
          nullable: true
        parcel_surface:
          type: integer
          title: Parcel Surface
          description: The lot/parcel surface in m2.
          example: 338
        volume:
          title: Volume
          description: Volume in cubic meters.
          example: 411
          type: integer
          nullable: true
        energy_label:
          title: Energy Label
          description: A label indicating how well the property object is insulated.
          example: E
          type: string
          nullable: true
        energy_label_is_registered:
          title: Energy Label Is Registered
          description: Boolean indicating whether the enery label has been registered.
          example: true
          type: boolean
          nullable: true
        energy_label_registration_valid_until:
          title: Energy Label Registration Valid Until
          description: Date until which the energy label is valid.
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        date_transaction:
          type: string
          format: date
          title: Date Transaction
          description: Transaction date
          example: '2025-11-10'
        price_class_low:
          type: integer
          title: Price Class Low
          description: Upper number of the price class based on indexed transaction
            price
          example: 1050000
        price_class_high:
          type: integer
          title: Price Class High
          description: Lower number of the price class based on indexed transaction
            price
          example: 1080000
        date_on_offer_since:
          title: Date On Offer Since
          description: Date since when the reference object is offered on the market.
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        offered_price:
          title: Offered Price
          description: Price for which the listing of the reference object is on offer
          example: 1000000
          type: integer
          nullable: true
        status:
          title: Status
          description: Status of the listing of the reference object (online/offline)
          example: online
          type: string
          nullable: true
        storage_space:
          title: Storage Space
          description: Storage space
          type: string
          nullable: true
        exterior_space:
          title: Exterior Space
          description: Exterior space
          type: string
          nullable: true
        garage:
          title: Garage
          description: Garage
          type: string
          nullable: true
        insulation:
          title: Insulation
          description: Insulation
          type: string
          nullable: true
        image_front:
          title: Image Front
          description: Url of the image of the front side of the house/object.
          type: string
          nullable: true
        image_other:
          title: Image Other
          description: List of image urls of the object.
          items:
            type: string
          type: array
          nullable: true
        description:
          title: Description
          description: Description of the listing of the reference object
          type: string
          nullable: true
        address_source:
          type: string
          title: Address Source
          description: Source of the address data value.
          example: BAG
        house_type_source:
          type: string
          title: House Type Source
          description: Source of the dwelling type value.
          example: BAG
        build_year_source:
          type: string
          title: Build Year Source
          description: Source of the build year value.
          example: BAG
        use_surface_source:
          type: string
          title: Use Surface Source
          description: Source of the use surface value.
          example: BAG
        parcel_surface_source:
          type: string
          title: Parcel Surface Source
          description: Source of the parcel surface value.
          example: BAG
        volume_source:
          title: Volume Source
          description: Source of the volume value.
          example: BAG
          type: string
          nullable: true
        energy_label_source:
          type: string
          title: Energy Label Source
          description: Source of the energy label value.
          example: EP Online
        date_transaction_source:
          type: string
          title: Date Transaction Source
          description: Source of the transaction date value.
          example: Kadaster
        date_on_offer_since_source:
          title: Date On Offer Since Source
          description: Source of the date on offer since value.
          example: Kadaster
          type: string
          nullable: true
        offered_price_source:
          title: Offered Price Source
          description: Source of the offered price value.
          example: Funda
          type: string
          nullable: true
        status_source:
          title: Status Source
          description: Source of the status value.
          example: Funda
          type: string
          nullable: true
        storage_space_source:
          title: Storage Space Source
          description: Source of the storage space value.
          example: Funda
          type: string
          nullable: true
        exterior_space_source:
          title: Exterior Space Source
          description: Source of the exterior space value.
          example: Funda
          type: string
          nullable: true
        garage_source:
          title: Garage Source
          description: Source of the garage value.
          example: Funda
          type: string
          nullable: true
        insulation_source:
          title: Insulation Source
          description: Source of the insulation value.
          example: Funda
          type: string
          nullable: true
        image_front_source:
          title: Image Front Source
          description: Source of the front view image url.
          example: Funda
          type: string
          nullable: true
        image_other_source:
          title: Image Other Source
          description: Source of the other image urls.
          example: Funda
          type: string
          nullable: true
        description_source:
          title: Description Source
          description: Source of the description value.
          example: Funda
          type: string
          nullable: true
        multiple_objects:
          type: boolean
          title: Multiple Objects
          description: Boolean indicating whether the address has multiple objects.
          example: true
        referenceTransactionApiCallPrice:
          title: Referencetransactionapicallprice
          description: WTF? Remove/hide?
          type: integer
          nullable: true
        transaction_price:
          title: Transaction Price
          description: The price of the transaction.
          example: 100000
          type: integer
          nullable: true
        similarity_score:
          type: number
          title: Similarity Score
          description: A weighted score on the comparability between the input house
            and the reference house, based on house type, build year, nett surface,
            parcel surface and energy label
          example: 99.84
        filling_grade:
          type: number
          title: Filling Grade
          description: A measure indicating the data coverage of all house characteristic
            data in percentage
          example: 86.66
        ownership_situation_funda:
          title: Ownership Situation Funda
          description: Funda ownership situation
          type: string
          nullable: true
        ownership_situation_kadaster:
          title: Ownership Situation Kadaster
          description: Kadaster ownership situation
          type: string
          nullable: true
        date_transport:
          type: string
          format: date
          title: Date Transport
          description: Date of transport
          example: '2025-11-10'
        date_sale:
          title: Date Sale
          description: Date of sale
          example: '2025-11-10'
          type: string
          format: date
          nullable: true
        transaction_price_indexed:
          type: integer
          title: Transaction Price Indexed
          description: The price of the transaction, indexed to the valuation date.
        transactions_price_indexed_date_transport:
          title: Transactions Price Indexed Date Transport
          description: The price of the transaction, indexed to the transport date.
          type: integer
          nullable: true
        transaction_price_indexed_date_sale:
          title: Transaction Price Indexed Date Sale
          description: The price of the transaction, indexed to the sale date.
          type: integer
          nullable: true
        is_monument:
          title: Is Monument
          description: Boolean indicating whether the house is a monument.
          default: false
          example: false
          type: boolean
          nullable: true
        nett_use_surface:
          title: Nett Use Surface
          description: Netto use surface
          example: 104
          type: integer
          nullable: true
        reference_score:
          type: number
          title: Reference Score
        date_score:
          type: number
          title: Date Score
        location_score:
          type: number
          title: Location Score
        house_details_score:
          type: number
          title: House Details Score
          description: A weighted score on the comparability between the input house
            and the reference house, based on house type, build year, nett surface,
            parcel surface and energy label
      type: object
      required:
      - index_nr
      - number_id
      - street_name
      - postal_code
      - house_number
      - city_name
      - municipality_name
      - province_name
      - latitude
      - longitude
      - distance
      - house_type
      - build_year
      - use_surface
      - use_surface_bag
      - parcel_surface
      - energy_label_is_registered
      - date_transaction
      - price_class_low
      - price_class_high
      - address_source
      - house_type_source
      - build_year_source
      - use_surface_source
      - parcel_surface_source
      - energy_label_source
      - date_transaction_source
      - status_source
      - multiple_objects
      - similarity_score
      - filling_grade
      - date_transport
      - transaction_price_indexed
      - reference_score
      - date_score
      - location_score
      - house_details_score
      title: ReferenceResponse
    ReferentieModel:
      properties:
        adres:
          $ref: '#/components/schemas/AdresModel'
        kenmerken:
          $ref: '#/components/schemas/KenmerkenModel'
        laatste_verkoop:
          $ref: '#/components/schemas/PrijsModel'
        afstand_tot_taxatieobject:
          type: number
          title: Afstand Tot Taxatieobject
      type: object
      required:
      - adres
      - kenmerken
      - laatste_verkoop
      - afstand_tot_taxatieobject
      title: ReferentieModel
    SewerCharge:
      properties:
        households:
          description: Taxes paid for sewage processing for households
          allOf:
          - $ref: '#/components/schemas/Households'
        businesses:
          description: Taxes paid for sewage processing for businesses
          allOf:
          - $ref: '#/components/schemas/Businesses'
      type: object
      required:
      - households
      - businesses
      title: SewerCharge
    SignaleringKadastraalObject:
      properties:
        tenBehoeveVan:
          title: Tenbehoevevan
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
        van:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: SignaleringKadastraalObject
    SourceHolder:
      properties:
        id:
          type: string
          title: Id
          description: Id of the source holder
          example: '0417'
        name:
          type: string
          title: Name
          description: Name of the source holder
          example: Laren (NH.)
      type: object
      required:
      - id
      - name
      title: SourceHolder
    Stukdeel:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        aard:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        datumKenbaarheidPB:
          title: Datumkenbaarheidpb
          type: string
          nullable: true
        omschrijvingGekozenWoonplaats:
          title: Omschrijvinggekozenwoonplaats
          type: string
          nullable: true
        isAanvullingOp:
          title: Isaanvullingop
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        bedragVorderingsbeslag:
          allOf:
          - $ref: '#/components/schemas/Bedrag'
          nullable: true
        bedragZekerheidsstellingHypotheek:
          allOf:
          - $ref: '#/components/schemas/Bedrag'
          nullable: true
      type: object
      title: Stukdeel
    TaxCredit:
      properties:
        multiPersonHousehold:
          type: number
          title: Multipersonhousehold
          description: Tax credit for multi person households
          example: 0.25
        singlePersonHousehold:
          type: number
          title: Singlepersonhousehold
          description: Tax credit for single person households
          example: 0.25
      type: object
      required:
      - multiPersonHousehold
      - singlePersonHousehold
      title: TaxCredit
    TaxatieModel:
      properties:
        adres:
          $ref: '#/components/schemas/AdresModel'
        kenmerken:
          $ref: '#/components/schemas/KenmerkenModel'
        aanvullende_kenmerken:
          $ref: '#/components/schemas/AanvullendeKenmerkenModel'
        laatste_verkoop:
          $ref: '#/components/schemas/PrijsModel'
      type: object
      required:
      - adres
      - kenmerken
      - aanvullende_kenmerken
      - laatste_verkoop
      title: TaxatieModel
    TekstveldmetbronModel:
      properties:
        waarde:
          title: Waarde
          type: string
          nullable: true
        bron:
          title: Bron
          type: string
          nullable: true
      type: object
      title: TekstveldmetbronModel
    Tenaamstelling:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        aandeel:
          allOf:
          - $ref: '#/components/schemas/TypeBreuk'
          nullable: true
        burgerlijkeStaatTenTijdeVanVerkrijging:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        omschrijving:
          title: Omschrijving
          type: string
          maxLength: 50
          minLength: 1
          nullable: true
        verkregenNamensSamenwerkingsverband:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        betrokkenPartner:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        geldtVoor:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        betrokkenSamenwerkingsverband:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        betrokkenGorzenEnAanwassen:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isGebaseerdOp:
          title: Isgebaseerdop
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
        van:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        tenNameVan:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: Tenaamstelling
    TerInschrijvingAangebodenStuk:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        type:
          type: string
          title: Type
          default: TerInschrijvingAangebodenStuk
        toelichtingBewaarder:
          title: Toelichtingbewaarder
          type: string
          nullable: true
        omvat:
          title: Omvat
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          nullable: true
        aard:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        deelEnNummer:
          allOf:
          - $ref: '#/components/schemas/TypeDeelEnNummer'
          nullable: true
        heeftKadasterVerzoek:
          title: Heeftkadasterverzoek
          type: boolean
          nullable: true
        statusStukOR:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        tekeningIngeschreven:
          title: Tekeningingeschreven
          type: boolean
          nullable: true
        tijdstipAanbieding:
          allOf:
          - $ref: '#/components/schemas/Tijdstip'
          nullable: true
        tijdstipOndertekening:
          allOf:
          - $ref: '#/components/schemas/Tijdstip'
          nullable: true
      type: object
      title: TerInschrijvingAangebodenStuk
    Tijdstip:
      properties:
        datum:
          type: string
          title: Datum
        tijd:
          title: Tijd
          type: string
          nullable: true
      type: object
      required:
      - datum
      title: Tijdstip
    Type:
      type: string
      enum:
      - Point
      title: Type
    TypeBreuk:
      properties:
        noemer:
          title: Noemer
          type: integer
          nullable: true
        teller:
          title: Teller
          type: integer
          nullable: true
      type: object
      title: TypeBreuk
    TypeDeelEnNummer:
      properties:
        deel:
          title: Deel
          type: string
          nullable: true
        nummer:
          title: Nummer
          type: string
          nullable: true
        reeks:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        registercode:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        soortRegister:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
      type: object
      title: TypeDeelEnNummer
    TypeKadastraleAanduiding:
      properties:
        appartementsrechtVolgnummer:
          title: Appartementsrechtvolgnummer
          type: integer
          nullable: true
        kadastraleGemeente:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        perceelnummer:
          title: Perceelnummer
          type: integer
          nullable: true
        sectie:
          title: Sectie
          type: string
          nullable: true
      type: object
      title: TypeKadastraleAanduiding
    TypeKoopsom:
      properties:
        bedrag:
          allOf:
          - $ref: '#/components/schemas/Bedrag'
          nullable: true
        indicatieMeerObjecten:
          title: Indicatiemeerobjecten
          type: boolean
          nullable: true
        koopjaar:
          title: Koopjaar
          type: integer
          nullable: true
      type: object
      title: TypeKoopsom
    TypeLandinrichtingsrente:
      properties:
        bedrag:
          allOf:
          - $ref: '#/components/schemas/Bedrag'
          nullable: true
        eindjaar:
          title: Eindjaar
          type: integer
          nullable: true
      type: object
      title: TypeLandinrichtingsrente
    TypeOnvolledigeDatum:
      properties:
        dag:
          title: Dag
          type: integer
          maximum: 31.0
          minimum: 1.0
          nullable: true
        datum:
          title: Datum
          type: string
          nullable: true
        jaar:
          title: Jaar
          type: integer
          maximum: 9999.0
          nullable: true
        maand:
          title: Maand
          type: integer
          maximum: 12.0
          minimum: 1.0
          nullable: true
      type: object
      title: TypeOnvolledigeDatum
    TypeOppervlak:
      properties:
        soortGrootte:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        waarde:
          title: Waarde
          type: number
          nullable: true
      type: object
      title: TypeOppervlak
    TypePostcode:
      type: string
      title: TypePostcode
    Utilities:
      properties:
        naturalGasUsageInCubicMeter:
          description: "Object containing average natural gas usage (in m\xB3) of\
            \ different house types"
          allOf:
          - $ref: '#/components/schemas/EnergyUsage'
        elektricityUsageKwh:
          description: Object containing average electricity usage (in kWh) of different
            house types
          allOf:
          - $ref: '#/components/schemas/EnergyUsage'
        percentageDistrictHeating:
          description: Object containing percentage of district heating for different
            house types
          allOf:
          - $ref: '#/components/schemas/EnergyUsage'
      type: object
      required:
      - naturalGasUsageInCubicMeter
      - elektricityUsageKwh
      - percentageDistrictHeating
      title: Utilities
    ValuationObjectResponse:
      properties:
        address:
          description: Address
          allOf:
          - $ref: '#/components/schemas/AddressResponse'
        houseDetails:
          description: House/Object details
          allOf:
          - $ref: '#/components/schemas/HouseDetailResponse'
        wozValue:
          type: integer
          title: Wozvalue
          description: WOZ value
          example: 930000
      type: object
      required:
      - address
      - houseDetails
      - wozValue
      title: ValuationObjectResponse
    Verblijfsobject:
      properties:
        identificatie:
          title: Identificatie
          type: string
          nullable: true
        hoofdadres:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: Verblijfsobject
    VerkavelObject:
      properties:
        betreft:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        ligtIn:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: VerkavelObject
    VermeldInStukkenItem:
      properties:
        vermeldInStuk:
          title: Vermeldinstuk
          description: Document this deed is mentioned in
          example: Hyp4 58968/193
          type: string
          nullable: true
        vermeldInStukIngeschrevenOp:
          title: Vermeldinstukingeschrevenop
          description: Date of registration
          example: 29-08-2025
          type: string
          nullable: true
        vermeldInStukSoort:
          title: Vermeldinstuksoort
          description: Type of registration
          type: string
          nullable: true
      type: object
      title: VermeldInStukkenItem
    VoorwaartseOnroerendeZaakFiliatie:
      properties:
        betreftOZ:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
      type: object
      title: VoorwaartseOnroerendeZaakFiliatie
    Waardelijst:
      properties:
        code:
          type: string
          title: Code
        waarde:
          title: Waarde
          type: string
          nullable: true
      type: object
      required:
      - code
      title: Waardelijst
    WozValues:
      properties:
        valuationDate:
          type: string
          format: date
          title: Valuationdate
          description: Valuation date
          example: '2024-01-01'
        wozValue:
          title: Wozvalue
          description: WOZ value
          example: 930000
          type: integer
          nullable: true
      type: object
      required:
      - valuationDate
      title: WozValues
    ZakelijkRecht:
      properties:
        identificatie:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        aard:
          allOf:
          - $ref: '#/components/schemas/Waardelijst'
          nullable: true
        toelichtingBewaarder:
          title: Toelichtingbewaarder
          type: string
          nullable: true
        isGebaseerdOp:
          title: Isgebaseerdop
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isVermeldIn:
          title: Isvermeldin
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        rustOp:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isBelastMet:
          title: Isbelastmet
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
        isOntstaanUit:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isBestemdTot:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isBetrokkenBij:
          allOf:
          - $ref: '#/components/schemas/NEN3610ID'
          nullable: true
        isBeperktTot:
          title: Isbeperkttot
          items:
            $ref: '#/components/schemas/NEN3610ID'
          type: array
          minItems: 0
          nullable: true
      type: object
      title: ZakelijkRecht
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: '{{API_KEY}}'
security:
- BearerAuth: []
