Skip to main content

List accounts

This recipe shows how to list reconciliation accounts in your tenant. Accounts represent the canonical reconciliation targets in FVI — bank accounts, GL accounts, sub-ledger accounts, and external counterparty accounts.

Endpoint​

GET /v1/accounts

Returns an array of accounts with the account UUID, display name, account type, source, currency, current balance, and last reconciliation status.

Prerequisites​

  • A valid tenantId and bearer JWT.
  • The user must have at least one of: tenant_admin, tenant_analyst, tenant_viewer.

Request​

curl -X GET "https://api.falconveritas.com/v1/accounts?limit=50&status=active" \
  -H "Authorization: Bearer $FVI_JWT" \
  -H "X-Tenant-Id: $FVI_TENANT_ID" \
  -H "Content-Type: application/json"

Response​

{
  "items": [
    {
      "id": "acc-001",
      "tenant_id": "f1a4e6e2-4b3e-4d2e-9b9c-3a2e9b1f4d5a",
      "display_name": "Operating Account - JPM NYC",
      "account_type": "bank_cash",
      "source": "jpmorgan_file",
      "currency": "USD",
      "current_balance": 12456023.42,
      "last_reconciled_at": "2026-08-22T03:00:00Z",
      "status": "active"
    },
    {
      "id": "acc-002",
      "tenant_id": "f1a4e6e2-4b3e-4d2e-9b9c-3a2e9b1f4d5a",
      "display_name": "General Ledger - Cash USD",
      "account_type": "gl",
      "source": "netsuite_gl",
      "currency": "USD",
      "current_balance": 12450000.00,
      "last_reconciled_at": "2026-08-22T03:00:00Z",
      "status": "active"
    }
  ],
  "next_cursor": null
}

Filter parameters​

ParameterTypeDescription
limitinteger (1-200, default 50)Maximum accounts to return
cursorstringPagination cursor
statusstringactive, archived, paused
account_typestringbank_cash, gl, sub_ledger, external, crypto_wallet
sourcestringFilter by ingestion source
currencystring (ISO 4217)Filter by currency code

Use cases​

  • Account picker UI — populate the dropdown of reconciliation targets.
  • Coverage dashboard — list all accounts and their last reconciliation status.
  • Audit listing — generate the account inventory for periodic review.

Code samples​

TypeScript​

import { FVI } from '@falconveritas/sdk';

const fvi = new FVI({
  baseUrl: 'https://api.falconveritas.com',
  bearer: process.env.FVI_JWT!,
  tenantId: process.env.FVI_TENANT_ID!,
});

const accounts = await fvi.accounts.list({
  status: 'active',
  limit: 100,
});

for (const account of accounts.items) {
  console.log(`${account.display_name} — ${account.currency} ${account.current_balance}`);
}

Python​

from falconveritas import FVI

client = FVI(
  bearer=os.environ["FVI_JWT"],
  tenant_id=os.environ["FVI_TENANT_ID"],
)

accounts = client.accounts.list(status="active", limit=100)
for account in accounts.items:
  print(f"{account.display_name} — {account.currency} {account.current_balance}")

Last updated: 2026-08-22 · Page owner: Documentation · Source: src/lib/api/accounts.ts.