Basiq API — Affordability

naftiko: 1.0.0-alpha2
info:
  label: Basiq API — Affordability
  description: 'Basiq API — Affordability. 2 operations. Lead operation: Get Expenses. Self-contained Naftiko capability covering
    one Basiq business surface.'
  tags:
  - Basiq
  - Affordability
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BASIQ_API_KEY: BASIQ_API_KEY
capability:
  consumes:
  - type: http
    namespace: basiq-affordability
    baseUri: https://au-api.basiq.io
    description: Basiq API — Affordability business capability. Self-contained, no shared references.
    resources:
    - name: users-userId-expenses
      path: /users/{userId}/expenses
      operations:
      - name: getexpenses
        method: GET
        description: Get Expenses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userId-income
      path: /users/{userId}/income
      operations:
      - name: getincomeverification
        method: GET
        description: Get Income Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.BASIQ_API_KEY}}'
  exposes:
  - type: rest
    namespace: basiq-affordability-rest
    port: 8080
    description: REST adapter for Basiq API — Affordability. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/users/{userid}/expenses
      name: users-userid-expenses
      description: REST surface for users-userId-expenses.
      operations:
      - method: GET
        name: getexpenses
        description: Get Expenses
        call: basiq-affordability.getexpenses
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/income
      name: users-userid-income
      description: REST surface for users-userId-income.
      operations:
      - method: GET
        name: getincomeverification
        description: Get Income Verification
        call: basiq-affordability.getincomeverification
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: basiq-affordability-mcp
    port: 9090
    transport: http
    description: MCP adapter for Basiq API — Affordability. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-expenses
      description: Get Expenses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-affordability.getexpenses
      outputParameters:
      - type: object
        mapping: $.
    - name: get-income-verification
      description: Get Income Verification
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: basiq-affordability.getincomeverification
      outputParameters:
      - type: object
        mapping: $.