> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sure.am/llms.txt
> Use this file to discover all available pages before exploring further.

# Discover FinanceKit background publisher support



## OpenAPI

````yaml /openapi.yaml get /api/v1/financekit/capabilities
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation generated from executable request specs.
servers:
  - url: https://app.sure.am
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/financekit/capabilities:
    get:
      tags:
        - FinanceKit
      summary: Discover FinanceKit background publisher support
      responses:
        '200':
          description: Publisher limits and protocol versions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitCapabilities'
        '400':
          description: Malformed or unsupported protocol
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '401':
          description: Invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '403':
          description: Insufficient permission or publisher eligibility
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '409':
          description: Enrollment, mapping, lineage, generation, or stream conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '413':
          description: Payload or record limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '422':
          description: Invalid typed record or consent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
        '429':
          description: Rate limited or publisher inbox full
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancekitError'
      security:
        - apiKeyAuth: []
        - oauth2:
            - read
components:
  schemas:
    FinancekitCapabilities:
      type: object
      additionalProperties: false
      required:
        - available
        - protocol_versions
        - delivery
        - max_payload_bytes
        - max_records
        - max_accounts
        - max_queued_batches
        - transaction_statuses
        - amount_precision
        - amount_scale
        - connection_dispositions
      properties:
        available:
          type: boolean
        protocol_versions:
          type: array
          items:
            type: integer
            enum:
              - 2
        delivery:
          type: string
          enum:
            - background_publisher
        max_payload_bytes:
          type: integer
        max_records:
          type: integer
        max_accounts:
          type: integer
        max_queued_batches:
          type: integer
        transaction_statuses:
          type: array
          items:
            type: string
        amount_precision:
          type: integer
        amount_scale:
          type: integer
        connection_dispositions:
          type: array
          items:
            type: string
            enum:
              - retain
              - discard
    FinancekitError:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            read: Read access
            read_write: Read and write access

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.