Yodlee Core APIs — Documents

naftiko: 1.0.0-alpha2
info:
  label: Yodlee Core APIs — Documents
  description: 'Yodlee Core APIs — Documents. 3 operations. Lead operation: Get Documents. Self-contained Naftiko capability
    covering one Yodlee business surface.'
  tags:
  - Yodlee
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    YODLEE_API_KEY: YODLEE_API_KEY
capability:
  consumes:
  - type: http
    namespace: core-documents
    baseUri: ''
    description: Yodlee Core APIs — Documents business capability. Self-contained, no shared references.
    resources:
    - name: documents
      path: /documents
      operations:
      - name: getdocuments
        method: GET
        description: Get Documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Keyword
          in: query
          type: string
          description: The string used to search a document by its name.
        - name: accountId
          in: query
          type: string
          description: The unique identifier of an account. Retrieve documents for a given accountId.
        - name: docType
          in: query
          type: string
          description: 'Accepts only one of the following valid document types: STMT, TAX, and EBILL.'
        - name: fromDate
          in: query
          type: string
          description: The date from which documents have to be retrieved.
        - name: toDate
          in: query
          type: string
          description: The date to which documents have to be retrieved.
    - name: documents-documentId
      path: /documents/{documentId}
      operations:
      - name: downloaddocument
        method: GET
        description: Download a Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: documentId
          in: path
          type: string
          description: documentId
          required: true
      - name: deletedocument
        method: DELETE
        description: Delete Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: documentId
          in: path
          type: string
          description: documentId
          required: true
  exposes:
  - type: rest
    namespace: core-documents-rest
    port: 8080
    description: REST adapter for Yodlee Core APIs — Documents. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/documents
      name: documents
      description: REST surface for documents.
      operations:
      - method: GET
        name: getdocuments
        description: Get Documents
        call: core-documents.getdocuments
        with:
          Keyword: rest.Keyword
          accountId: rest.accountId
          docType: rest.docType
          fromDate: rest.fromDate
          toDate: rest.toDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{documentid}
      name: documents-documentid
      description: REST surface for documents-documentId.
      operations:
      - method: GET
        name: downloaddocument
        description: Download a Document
        call: core-documents.downloaddocument
        with:
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedocument
        description: Delete Document
        call: core-documents.deletedocument
        with:
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: core-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Yodlee Core APIs — Documents. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-documents
      description: Get Documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-documents.getdocuments
      with:
        Keyword: tools.Keyword
        accountId: tools.accountId
        docType: tools.docType
        fromDate: tools.fromDate
        toDate: tools.toDate
      outputParameters:
      - type: object
        mapping: $.
    - name: download-document
      description: Download a Document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: core-documents.downloaddocument
      with:
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-document
      description: Delete Document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: core-documents.deletedocument
      with:
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.