Skip to main content
Returns a snapshot of every connected account with individual balances and aggregated totals grouped by account type.

​
Parameters

No parameters required.

​
Response

FieldTypeDescription
total_accountsintegerNumber of connected accounts
accountsarrayPer-account details
accounts[].typestringAccount type (CHECKING, SAVINGS, CREDIT_CARD, LOAN, etc.)
accounts[].maskstringMasked account number
accounts[].nicknamestringAccount display name
accounts[].balancesobjectBalance information
accounts[].balances.currency_codestringISO 4217 currency code
accounts[].balances.balancestringCurrent balance
accounts[].balances.available_balancestringAvailable balance
accounts[].balances.credit_limitstringCredit limit (if applicable)
accounts[].providerobjectFinancial institution details (id, name, logo_url)
aggregated_balancesarrayTotals grouped by account type and currency
aggregated_balances[].typestringAccount type
aggregated_balances[].balancestringSum of balances for this type
aggregated_balances[].account_countintegerNumber of accounts in this group

​
Example

Prompt: “What’s my current balance across all accounts?” 
{
  "total_accounts": 3,
  "accounts": [
    {
      "type": "CHECKING",
      "mask": "4521",
      "nickname": "Main Checking",
      "balances": {
        "currency_code": "USD",
        "balance": "3842.50",
        "available_balance": "3842.50",
        "credit_limit": "0.00"
      },
      "provider": {
        "id": "chase",
        "name": "Chase",
        "logo_url": "https://cdn.mytruv.com/providers/chase.png"
      }
    }
  ],
  "aggregated_balances": [
    {
      "type": "CHECKING",
      "currency_code": "USD",
      "balance": "3842.50",
      "account_count": 1
    }
  ]
}