Accounts

List all financial accounts

Returns a paginated list of the authenticated user's financial accounts.

GET

/finance/accounts

curl --request GET \
  --url https://api.synci.io/api/v1/finance/accounts \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "account_category": "<string>",
      "account_number_masked": "<string>",
      "account_usage": "<string>",
      "balance": {
        "available": "<string>",
        "cleared": "<string>"
      },
      "balances_last_synced_at": "<string>",
      "bban": "<string>",
      "bic": "<string>",
      "cash_account_type": "<string>",
      "cash_balance": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "config": {
        "enrichment": {
          "country": "<string>",
          "enabled": "<string>",
          "provider": "<string>"
        },
        "fields_for_duplicate_filtering": [
          "<string>"
        ],
        "fuzzy_counterparty_matching": "<string>",
        "fuzzy_counterparty_min_chars": "<string>",
        "map_fields": {
          "date": "<string>",
          "description": "<string>",
          "payee": "<string>"
        },
        "pending_settlement_matching": "<string>",
        "pending_settlement_max_days": "<string>",
        "sync_auto": "<string>",
        "sync_balances": "<string>",
        "sync_frequency_in_minutes": "<string>",
        "sync_pending_transactions": "<string>",
        "sync_start_date": "2025-01-01"
      },
      "created_at": "<string>",
      "currency": "<string>",
      "custom_name": "<string>",
      "details": "<string>",
      "details_last_synced_at": "<string>",
      "display_name": "<string>",
      "enabled": "<string>",
      "financial_connection": {
        "access_valid_for_days": "<string>",
        "accounts_last_synced_at": "<string>",
        "activated_at": "<string>",
        "consent_expires_at": "<string>",
        "created_at": "<string>",
        "enabled": "<string>",
        "financial_accounts": [
          {}
        ],
        "financial_accounts_count": "<string>",
        "health": {
          "failure_count": "<string>",
          "integrator_message": "<string>",
          "last_attempt_at": "<string>",
          "status": "<string>",
          "transient_failure_count": "<string>",
          "transient_message": "<string>"
        },
        "id": "<string>",
        "institution": {
          "bic": "<string>",
          "category": "<string>",
          "country": "<string>",
          "external_id": "<string>",
          "id": "<string>",
          "integrator": "<string>",
          "logo": "<string>",
          "max_access_valid_for_days": "<string>",
          "max_historical_days": "<string>",
          "name": "<string>",

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Omit sensitive financial account/card number identifiers, and certain direct identifiers from the response. Currently, the following fields will be omitted: iban, bban, scan, owner_name, owner_address, bic, msisdn, account_number_masked, integrator_id, institution_id.

page[size]integerquerydefault:25

The number of results that will be returned per page.

page[number]integerquery

The page number to start the pagination from.

filter[id]stringquery

filter[name]stringquery

filter[display_name]stringquery

filter[enabled]stringquery

filter[financial_connection_id]stringquery

filter[bban]stringquery

filter[iban]stringquery

filter[institution_config_id]stringquery

filter[bic]stringquery

filter[currency]stringquery

filter[product_name]stringquery

filter[source_type]stringquery

filter[integrator_id]stringquery

filter[institution_id]stringquery

filter[account_category]stringquery

filter[integrator]stringquery

filter[category]stringquery

Filter by the institution's category — distinguishes crypto exchanges (e.g. Coinbase, Kraken) from regular brokerages. ?filter[category]=CRYPTO → only crypto-exchange accounts ?filter[category]=BROKERAGE → only brokerage accounts

filter[domain]stringquery

Filter by data domain. ?filter[domain]=bank → bank accounts (GoCardless, Akahu, Array, demo banks) ?filter[domain]=asset → investment accounts (SnapTrade, Array brokerages) Integrator lists come from IntegratorEnum so a new provider lands here automatically; DEMO is a bank account for the same reason it is a bank connection.

The account's own category is consulted as well, because Array is the first integrator on both sides of the line: one link carries a checking account and a brokerage account. A bank-domain integrator's INVESTMENT/DEPOSIT accounts therefore belong in asset, and are excluded from bank.

sortenum<string>[]querydefault:["-id"]

includeenum<string>[]query

Response

Paginated set of FinancialAccountResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team

Authorizations

Query Parameters

Response