Broadridge Wealth Management API — Accounts

naftiko: 1.0.0-alpha2
info:
  label: Broadridge Wealth Management API — Accounts
  description: 'Broadridge Wealth Management API — Accounts. 3 operations. Lead operation: List accounts. Self-contained Naftiko
    capability covering one Broadridge business surface.'
  tags:
  - Broadridge
  - Accounts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BROADRIDGE_API_KEY: BROADRIDGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: wealth-accounts
    baseUri: https://api.broadridge.example.com
    description: Broadridge Wealth Management API — Accounts business capability. Self-contained, no shared references.
    resources:
    - name: wealth-v1-accounts
      path: /wealth/v1/accounts
      operations:
      - name: listaccounts
        method: GET
        description: List accounts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountType
          in: query
          type: string
          description: Filter by account type
        - name: status
          in: query
          type: string
        - name: repId
          in: query
          type: string
          description: Filter by registered representative ID
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
    - name: wealth-v1-accounts-accountNumber
      path: /wealth/v1/accounts/{accountNumber}
      operations:
      - name: getaccount
        method: GET
        description: Get account details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountNumber
          in: path
          type: string
          description: Account number
          required: true
    - name: wealth-v1-accounts-accountNumber-balances
      path: /wealth/v1/accounts/{accountNumber}/balances
      operations:
      - name: getaccountbalances
        method: GET
        description: Get account balances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: accountNumber
          in: path
          type: string
          required: true
        - name: asOfDate
          in: query
          type: string
          description: Get balances as of a specific date
    authentication:
      type: bearer
      token: '{{env.BROADRIDGE_API_KEY}}'
  exposes:
  - type: rest
    namespace: wealth-accounts-rest
    port: 8080
    description: REST adapter for Broadridge Wealth Management API — Accounts. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/wealth/v1/accounts
      name: wealth-v1-accounts
      description: REST surface for wealth-v1-accounts.
      operations:
      - method: GET
        name: listaccounts
        description: List accounts
        call: wealth-accounts.listaccounts
        with:
          accountType: rest.accountType
          status: rest.status
          repId: rest.repId
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wealth/v1/accounts/{accountnumber}
      name: wealth-v1-accounts-accountnumber
      description: REST surface for wealth-v1-accounts-accountNumber.
      operations:
      - method: GET
        name: getaccount
        description: Get account details
        call: wealth-accounts.getaccount
        with:
          accountNumber: rest.accountNumber
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wealth/v1/accounts/{accountnumber}/balances
      name: wealth-v1-accounts-accountnumber-balances
      description: REST surface for wealth-v1-accounts-accountNumber-balances.
      operations:
      - method: GET
        name: getaccountbalances
        description: Get account balances
        call: wealth-accounts.getaccountbalances
        with:
          accountNumber: rest.accountNumber
          asOfDate: rest.asOfDate
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: wealth-accounts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Broadridge Wealth Management API — Accounts. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-accounts
      description: List accounts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: wealth-accounts.listaccounts
      with:
        accountType: tools.accountType
        status: tools.status
        repId: tools.repId
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-account-details
      description: Get account details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: wealth-accounts.getaccount
      with:
        accountNumber: tools.accountNumber
      outputParameters:
      - type: object
        mapping: $.
    - name: get-account-balances
      description: Get account balances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: wealth-accounts.getaccountbalances
      with:
        accountNumber: tools.accountNumber
        asOfDate: tools.asOfDate
      outputParameters:
      - type: object
        mapping: $.