Yodlee Core APIs — Providers

naftiko: 1.0.0-alpha2
info:
  label: Yodlee Core APIs — Providers
  description: 'Yodlee Core APIs — Providers. 3 operations. Lead operation: Get Providers. Self-contained Naftiko capability
    covering one Yodlee business surface.'
  tags:
  - Yodlee
  - Providers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    YODLEE_API_KEY: YODLEE_API_KEY
capability:
  consumes:
  - type: http
    namespace: core-providers
    baseUri: ''
    description: Yodlee Core APIs — Providers business capability. Self-contained, no shared references.
    resources:
    - name: providers
      path: /providers
      operations:
      - name: getallproviders
        method: GET
        description: Get Providers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: capability
          in: query
          type: string
          description: CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated
        - name: dataset$filter
          in: query
          type: string
          description: 'Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be
            the dataset or dataset attributes configured as default for '
        - name: fullAccountNumberFields
          in: query
          type: string
          description: Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.
        - name: institutionId
          in: query
          type: integer
          description: Institution Id for Single site selection
        - name: name
          in: query
          type: string
          description: Name in minimum 1 character or routing number.
        - name: priority
          in: query
          type: string
          description: Search priority
        - name: providerId
          in: query
          type: string
          description: Max 5 Comma seperated Provider Ids
        - name: skip
          in: query
          type: integer
          description: skip (Min 0) - This is not applicable along with 'name' parameter.
        - name: top
          in: query
          type: integer
          description: top (Max 500) - This is not applicable along with 'name' parameter.
    - name: providers-count
      path: /providers/count
      operations:
      - name: getproviderscount
        method: GET
        description: Get Providers Count
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: capability
          in: query
          type: string
          description: CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated
        - name: dataset$filter
          in: query
          type: string
          description: 'Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be
            the dataset or dataset attributes configured as default for '
        - name: fullAccountNumberFields
          in: query
          type: string
          description: Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber.
        - name: name
          in: query
          type: string
          description: Name in minimum 1 character or routing number.
        - name: priority
          in: query
          type: string
          description: Search priority
    - name: providers-providerId
      path: /providers/{providerId}
      operations:
      - name: getprovider
        method: GET
        description: Get Provider Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: providerId
          in: path
          type: integer
          description: providerId
          required: true
  exposes:
  - type: rest
    namespace: core-providers-rest
    port: 8080
    description: REST adapter for Yodlee Core APIs — Providers. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/providers
      name: providers
      description: REST surface for providers.
      operations:
      - method: GET
        name: getallproviders
        description: Get Providers
        call: core-providers.getallproviders
        with:
          capability: rest.capability
          dataset$filter: rest.dataset$filter
          fullAccountNumberFields: rest.fullAccountNumberFields
          institutionId: rest.institutionId
          name: rest.name
          priority: rest.priority
          providerId: rest.providerId
          skip: rest.skip
          top: rest.top
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/providers/count
      name: providers-count
      description: REST surface for providers-count.
      operations:
      - method: GET
        name: getproviderscount
        description: Get Providers Count
        call: core-providers.getproviderscount
        with:
          capability: rest.capability
          dataset$filter: rest.dataset$filter
          fullAccountNumberFields: rest.fullAccountNumberFields
          name: rest.name
          priority: rest.priority
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/providers/{providerid}
      name: providers-providerid
      description: REST surface for providers-providerId.
      operations:
      - method: GET
        name: getprovider
        description: Get Provider Details
        call: core-providers.getprovider
        with:
          providerId: rest.providerId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: core-providers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Yodlee Core APIs — Providers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-providers
      description: Get Providers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-providers.getallproviders
      with:
        capability: tools.capability
        dataset$filter: tools.dataset$filter
        fullAccountNumberFields: tools.fullAccountNumberFields
        institutionId: tools.institutionId
        name: tools.name
        priority: tools.priority
        providerId: tools.providerId
        skip: tools.skip
        top: tools.top
      outputParameters:
      - type: object
        mapping: $.
    - name: get-providers-count
      description: Get Providers Count
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-providers.getproviderscount
      with:
        capability: tools.capability
        dataset$filter: tools.dataset$filter
        fullAccountNumberFields: tools.fullAccountNumberFields
        name: tools.name
        priority: tools.priority
      outputParameters:
      - type: object
        mapping: $.
    - name: get-provider-details
      description: Get Provider Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-providers.getprovider
      with:
        providerId: tools.providerId
      outputParameters:
      - type: object
        mapping: $.