FI Attributes

API resources have a field where you can attach arbitrary data. We refer to this arbitrary data as FI Attributes and you can access it via the fiAttributes parameter.

FiAttribute:
    title: FI Attribute entity
    description: Financial institution-specific attribute
    type: object
    properties:
        name:
          type: string
          description: Name of attribute
        value:
          type: string
          description: Value of attribute

FI Attributes are useful for storing additional, structured data alongside an API object. See the example below.

AccountDescriptor:
  title: Account Descriptor entity
  description: This descriptor provides minimal information about the account
  type: object
  properties:
    ...
    ...
    fiAttributes:
      type: array
      description: Array of Financial institution-specific attributes
      items:
        $ref: '#/components/schemas/FiAttribute'

For more information about our APIs please refer to our API Reference

Pagination

Errors