Accounts

Search financial accounts

Use this endpoint to filter financial accounts by various parameters.

get/bank-linking/accounts

Request

Query parameters

customerIdstring

Meld generated unique identifier for your customer. This should be used to track customer activity. Should not be provided in conjunction with externalCustomerId

externalCustomerIdstring

Your unique identifier for your customer. If maintaining your own customer management system this can also be used for tracking customer activity. Should not be provided in conjunction with customerId

institutionIdstring

Institution id

connectionIdstring

Connection id

beforestring

Unique key corresponding to a financial account's position in the paginated list of results -- used to indicate that only financial accounts residing before this key will be retrieved.

Each financial account carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

afterstring

Unique key corresponding to a financial account's position in the paginated list of results -- used to indicate that only financial accounts residing after this key will be retrieved.

Each financial account carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

limitstring

Limits number of returned financial accounts.

Default value: 10

Minimum value: 1

Maximum value: 100

Response

Financial accounts are returned

countinteger

Number of financial accounts returned.

remaininginteger

Number of remaining financial accounts before/after this page, depending on the direction this page was selected.

Example response

{
  "financialAccounts": [
    {
      "owners": [
        {
          "addresses": [
            {
              "country": "US"
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.