List accounts

This endpoint allows to list accounts for a consumer.

Request

POST /insights/v1/storage/accounts/list HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Token <Token>
Host: <Host>

{
    "insights_consumer_id": String,
    "pagination": ?{
        "size": Integer,
        "offset": Integer
    }
}

insights_consumer_id String, required

The insights_consumer_id parameter identifies the consumer whose accounts are returned.

pagination.size Integer, required

Maximum number of accounts returned in one response. The default is 50, the maximum is 1000.

pagination.offset Integer, required

Number of accounts that are skipped. The default is 0, the maximum is 1000.

Response

{
    "data": {
        "accounts": Array<{
            "insights_account_id": String,
            "iban": : ?String,
            "account_number": ?String,
            "alias": ?String,
            "bic": ?String,
            "bank_code": ?String,
            "holder_name": ?String,
            "account_type": ?Enum<'DEFAULT', 'SAVING', 'CREDITCARD', 'DEPOT'>,
            "transfer_type": ?Enum<'NONE', 'DOMESTIC', 'FULL', 'REFERENCE', 'RESTRICTED'>,
            "currency": ?String,
            "refreshed_at": DateTime,
            "consent_expected_expiry_date": ?Date,
            "accounts_group_id": ?String,
            "holder_address": ?{
                "country": ?String
            },
            "labels": ?{
                <label_key>: String,
            }
        }>,
        "pagination": PaginationResponse
    }
}

data.accounts.insights_account_id String, always present

The account's Account Insights id.

data.accounts.iban String, optional

The account's IBAN.

data.accounts.account_number String, optional

The account's account number.

data.accounts.alias String, optional

The account's alias.

data.accounts.bic String, optional

The account's BIC.

data.accounts.bank_code String, optional

The account's bank code.

data.accounts.holder_name String, optional

The account's holder name.

refreshed_at DateTime (String: "YYYY-MM-DDThh:mm:ss.sssZ), always present

The refreshed_at shows when the data for this account were last refreshed.

consent_expected_expiry_date Date (String: "YYYY-MM-DD"), optional

The expected expiry date of a stored consent. Present if there is a stored consent for the account in question.

Will be in the format of YYYY-MM-DD according to ISO 8601.

data.accounts.account_type Enum, optional

The account's account type.

  • DEFAULT - A regular account.
  • SAVING - A savings account.
  • CREDITCARD - A credit card account.
  • DEPOT - A depot for broking or similar.

data.accounts.transfer_type Enum, optional

The account's transfer type.

  • NONE - It is not possible to use the account for transfers.
  • DOMESTIC - The account can only be used for domestic transfers.
  • FULL - The account is fully usable.
  • REFERENCE - The account can only be used for transfers to one specific account.
  • RESTRICTED - The account might be under protection from execution or something similar. Transfers are possible, but with restricted functionality (e.g. limited transfer amount).

accounts_group_id String, optional

Accounts that are connected to other accounts are grouped by having the same id. Bank accounts with the same accounts_group_id are received from the same bank-account.

data.accounts.currency String, optional

The currency of the balance of this account.

data.accounts.holder_address.country String, optional

The account country as code in the ISO 3166-1 alpha-2 format, e.g. DE, GB, SE.

data.accounts.labels Object, optional

Any amount of labels consisting of key-value pairs.

data.pagination PaginationResponse, always present

Pagination object which contains various information about the current and possible previous/next page.

results matching ""

    No results matching ""