{ "id": "acc_FINICITY_45", "source": "FINICITY", "type": "credit_card", "iso_currency_code": "USD", "connection_id": "con_FINICITY_41294", "client_id": "<string>", "name": "<string>", "subtype": "money_market", "mask": "1234", "current_balance": -1234.56, "available_balance": 123, "last_refreshed_at": "2023-11-07T05:31:56Z", "oldest_transaction_date": "2023-04-11", "liabilities": { "credit_limit": 65000, "available_credit": 50596.54, "statement_balance": -14381.66, "statement_date": "2026-08-28", "remaining_statement_balance": -9381.66, "minimum_payment": 143, "payment_due_date": "2026-09-24" }, "realized_capabilities": { "transactions": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "balance": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "available_balance": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "statements": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "check_images": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } } }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z"}
{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}
{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}
Accounts
Get an account
Look up a single Account by id. Returns name, type, current
balance, mask (at most the last 4 digits of the account number,
on every source), and the Connection it came from.
{ "id": "acc_FINICITY_45", "source": "FINICITY", "type": "credit_card", "iso_currency_code": "USD", "connection_id": "con_FINICITY_41294", "client_id": "<string>", "name": "<string>", "subtype": "money_market", "mask": "1234", "current_balance": -1234.56, "available_balance": 123, "last_refreshed_at": "2023-11-07T05:31:56Z", "oldest_transaction_date": "2023-04-11", "liabilities": { "credit_limit": 65000, "available_credit": 50596.54, "statement_balance": -14381.66, "statement_date": "2026-08-28", "remaining_statement_balance": -9381.66, "minimum_payment": 143, "payment_due_date": "2026-09-24" }, "realized_capabilities": { "transactions": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "balance": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "available_balance": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "statements": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } }, "check_images": { "status": "succeeded", "last_success_at": "2023-11-07T05:31:56Z", "next_refresh_after": "2023-11-07T05:31:56Z", "last_error": { "code": "unknown_api_key", "message": "The API key you presented doesn't match any active key.", "type": "auth_error", "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key", "category": "AUTH_ERROR", "is_user_actionable": true, "source_diagnostic_code": "FIN-103", "param": "client.email", "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736", "errors": [ { "param": "client.email", "message": "must be a valid email address", "code": "invalid_email" } ] } } }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z"}
{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}
{
"error": {
"code": "unknown_api_key",
"message": "The API key you presented doesn't match any active key.",
"type": "auth_error",
"doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
"category": "AUTH_ERROR",
"is_user_actionable": true,
"source_diagnostic_code": "FIN-103",
"param": "client.email",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
"errors": [
{
"param": "client.email",
"message": "must be a valid email address",
"code": "invalid_email"
}
]
}
}
Authorizations
Authorization
string
header
required
Pass your secret key in the Authorization header as a Bearer
token: Authorization: Bearer sk_test_... (sandbox) or
Bearer sk_live_... (production).
Keys are created in the developer portal and the plaintext
secret is shown exactly once at creation. Treat them like
passwords — never embed them in mobile apps or front-end code.
Path Parameters
account_id
string
required
Query Parameters
client_id
string
required
The Client (cli_…) to scope the read to. Required on account,
transaction, and statement reads — LedgerSync's backend data APIs
are scoped per end-user, so these resources are resolved within a
single Client. Check corrections are scoped the same way.
Response
The Account.
id
string
required
Example:
"acc_FINICITY_45"
source
enum<string>
required
Financial-data source backing an account. Aggregator sources
(FINICITY, MX) and FDE back a Connection; PDF does not.
PDF — Uploaded bank statements. Read-only: exposed on
/accounts and /transactions (statements are not served for
PDF), and never as a Connection (PDF accounts have
connection_id: null).
Available options:
FINICITY,
MX,
FDE,
PDF
type
enum<string>
required
Coarse account classification, normalized by LedgerSync so the same six values mean the same thing on every source. Always present. other means the source did not classify the account, or classified it as something with no home in this enum (a rewards balance, an MX "other liability") - read subtype to tell those apart. This list is closed and stable; new upstream products appear in subtype, never here.
Available options:
checking,
savings,
credit_card,
loan,
investment,
other
Example:
"credit_card"
iso_currency_code
string
required
ISO-4217 currency code. Defaults to USD when the source omits it.
Example:
"USD"
connection_id
string | null
Owning connection — canonical id (con_<SOURCE>_<bankAccountId>). Null on a sandbox single-fetch (a sandbox account id doesn't encode its connection). Always present when listing accounts by connection.
Example:
"con_FINICITY_41294"
client_id
string
name
string
subtype
string
The finer label the source reported, before it was collapsed into type. Always present. This is an OPEN vocabulary that grows as sources report new products, which is why it is a plain string and not an enum: a new value here is never a breaking change. Branch on type; use subtype for display, or for finer routing you control and can update. unknown when the source reported no type at all, which today is every FDE account and roughly half of the accounts created from uploaded statements. Examples of the collapse: money_market and certificate_of_deposit report type: savings; mortgage and line_of_credit report type: loan; ira, roth and plan_401k report type: investment; bank reports type: checking.
Pattern: ^[a-z0-9_]+$
Example:
"money_market"
mask
string | null
Last 4 digits of the account number (Plaid-style mask), on every source. Never more than 4 digits, fewer when the source holds a shorter number, and null when it holds none.
Example:
"1234"
current_balance
number | null
Most recent balance in the account's currency, as a decimal, signed from the account holder's point of view and normalized by LedgerSync so it means the same thing on every source. Positive is value you hold, negative is value you owe, so summing this across a client's accounts gives net worth. A credit card or loan carrying a balance is therefore negative, and a checking account in overdraft is negative too. The sign is meaningful in both directions: an overpaid card with a real credit balance is positive. Null when the source hasn't reported one yet. The account.refresh.completed webhook reports the same account with the same sign, wrapped as {amount, iso_currency_code} rather than a bare decimal.
Example:
-1234.56
available_balance
number | null
Available balance, when the source distinguishes it from the current balance. On a credit card this is available credit, an amount you can spend, so it is NOT sign-flipped the way current_balance is and is normally positive. MX is the only source that reports it, and only for some accounts (common on checking, rare on cards), so it is null far more often than not. Check realized_capabilities.available_balance rather than assuming it is present.
last_refreshed_at
string<date-time> | null
oldest_transaction_date
string<date> | null
How far back our transaction history for this account actually goes: the date of the oldest transaction we hold. It is the minimum date you will see if you page this account's entire history through GET /accounts/{account_id}/transactions. Measured from the transactions we hold, not a claim by the aggregator about what it could supply. Null means we hold no transactions for this account at all, which is normal for one that was linked but has not completed a first refresh. It moves backwards, never forwards, when a backfill lands, and it is not a promise about what a future refresh will retrieve.
Example:
"2023-04-11"
liabilities
object | null
Credit terms for this account: what the client can borrow,
what they owed at the last statement close, how much of that is
still unpaid, and what the bank wants next. Present only on
liability accounts: credit cards,
lines of credit, loans and mortgages. Null on every other account
(checking, savings, investment), even when the source reports
terms for it, and also on liability accounts at institutions that
do not report these values, so its presence is itself the signal
that anything is known. Individual fields inside it are
independently nullable for the same reason.
Show child attributes
realized_capabilities
object | null
Per-account observed outcome of the most recent attempt at
each capability. Today the backend tracks status at the
bank level — accounts within the same connection share this
snapshot. Per-account divergence (one account in a
connection failed but others succeeded) requires a backend
extension and is deferred.
Show child attributes
created_at
string<date-time> | null
When LedgerSync first stored this account, which is when we
first saw it at the source. For accounts present at link time
this tracks the connection; for one shared later it is when it
arrived. There is no account.added webhook, so this is the
field to sort or diff on when you re-list accounts to find what
is new. It never moves afterwards.
updated_at
string<date-time> | null
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LedgerSync","description":"Connect your users' bank accounts and pull their transactions, statements, and balances through one uniform API.","colors":{"primary":"#0891B2","light":"#22D3EE","dark":"#0E7490"},"logo":{"light":"https://mintcdn.com/ledgersync/NVbCdX0lsP_TgYmH/logo/ledgersync-wordmark.png?fit=max\u0026auto=format\u0026n=NVbCdX0lsP_TgYmH\u0026q=85\u0026s=b149d57dc2f40804f937b11e31060496","dark":"https://mintcdn.com/ledgersync/NVbCdX0lsP_TgYmH/logo/ledgersync-wordmark.png?fit=max\u0026auto=format\u0026n=NVbCdX0lsP_TgYmH\u0026q=85\u0026s=b149d57dc2f40804f937b11e31060496"},"favicon":"https://mintcdn.com/ledgersync/NVbCdX0lsP_TgYmH/favicon.png?fit=max\u0026auto=format\u0026n=NVbCdX0lsP_TgYmH\u0026q=85\u0026s=223187cbc5ee95ae162ffd35e5935db1","navbar":{"links":[{"href":"mailto:support@ledgersync.com","label":"Support"}],"primary":{"type":"button","label":"Request access","href":"https://portal.ledgersyncappv2.com"}},"footer":{"socials":{"website":"https://ledgersync.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ledgersync","hasAudioNarration":false,"actualSubdomain":"ledgersync","customDomains":["docs.ledgersyncappv2.com"],"gitSource":{"type":"github","owner":"ledgersync-app","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6add29d60504bfbbf7e80db6"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b00d931407c66bc0b804a16","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":59},{"language":"default","tag":"v2 API (legacy)","count":50},{"language":"default","tag":"LedgerSync MCP","count":39},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Connections","count":9},{"language":"default","tag":"account-api","count":9},{"language":"default","tag":"Clients","count":8},{"language":"default","tag":"client-api","count":8},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Webhooks","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"ai-connector.css","content":".lsai-page{--lsai-green: #1b7a52;--lsai-green-dark: #155f40;--lsai-fill: #1b7a52;--lsai-fill-hover: #155f40;--lsai-green-soft: #e8f5ee;--lsai-green-line: #c9e3d5;--lsai-ink: #1f2937;--lsai-muted: #6b7280;--lsai-line: #e3e8ec;--lsai-card: #ffffff;--lsai-gray-soft: #f3f5f7;--lsai-yellow-soft: #fdf6dd;--lsai-yellow-line: #efd78f;--lsai-red-soft: #fdecec;--lsai-red-line: #f3b9b9;--lsai-bg: rgb(var(--background-light, 255 255 255));max-width:880px;margin:0 auto;padding:32px 24px 48px;color:var(--lsai-ink);font-size:16px;line-height:1.6}.dark .lsai-page{--lsai-green: #3fb27f;--lsai-green-dark: #57c592;--lsai-green-soft: #12291f;--lsai-green-line: #24513a;--lsai-ink: #e5e7eb;--lsai-muted: #9ca3af;--lsai-line: #2b3138;--lsai-card: #14181c;--lsai-gray-soft: #1a1f24;--lsai-yellow-soft: #2a2412;--lsai-yellow-line: #5c4c1c;--lsai-red-soft: #2c1717;--lsai-red-line: #6a2c2c;--lsai-bg: rgb(var(--background-dark, 10 13 16))}.lsai-title{font-size:2rem;line-height:1.2;font-weight:700;margin:0 0 8px;color:var(--lsai-ink)}.lsai-subtitle{font-size:1.05rem;color:var(--lsai-muted);margin:0 0 20px}.lsai-page h2{font-size:1.3rem;font-weight:700;margin:28px 0 12px;color:var(--lsai-ink)}.lsai-page h3{font-size:1.1rem;font-weight:700;margin:20px 0 8px;color:var(--lsai-ink)}.lsai-page p,.lsai-page span[data-as=\"p\"]{display:block;margin:0 0 10px}.lsai-step-text>span[data-as=\"p\"]:last-child,.lsai-note>span[data-as=\"p\"]:last-child,.lsai-choice-text>span[data-as=\"p\"]:last-child,.lsai-box-text>span[data-as=\"p\"]:last-child,.lsai-test-more>span[data-as=\"p\"]:last-child{margin-bottom:0}.lsai-page a:not(.lsai-btn):not(.lsai-thumb){color:var(--lsai-green);font-weight:600;text-decoration:none}.lsai-page a:not(.lsai-btn):not(.lsai-thumb):hover{text-decoration:underline}.lsai-page ul,.lsai-page ol:not(.lsai-progress){margin:4px 0 10px;padding-left:22px}.lsai-page li{margin:2px 0}.lsai-page ul li{list-style:disc}.lsai-page .prose li{list-style:none}.lsai-page ol:not(.lsai-progress) li{list-style:decimal}.lsai-page code:not(.lsai-copy-text){font-size:0.9em;background:var(--lsai-gray-soft);border-radius:4px;padding:1px 5px}.lsai-page table{width:100%;border-collapse:collapse;margin:8px 0 16px;font-size:0.95rem}.lsai-page th{text-align:left;background:var(--lsai-gray-soft);font-weight:700;padding:8px 10px;border-bottom:1px solid var(--lsai-line)}.lsai-page td{padding:8px 10px;border-bottom:1px solid var(--lsai-line);vertical-align:top}.lsai-head{display:flex;flex-wrap:wrap;align-items:flex-start;justify-content:space-between;gap:12px 20px}.lsai-head-text{flex:1 1 420px;min-width:0}.lsai-video-button{display:flex;flex:0 0 auto;align-items:center;gap:10px;width:max-content;max-width:100%;cursor:pointer;border:1px solid var(--lsai-line);border-radius:12px;padding:10px 16px 10px 10px;background:var(--lsai-card);box-shadow:0 1px 2px rgba(0, 0, 0, 0.06);font:inherit;color:var(--lsai-ink);text-align:left}.lsai-video-button:hover{border-color:var(--lsai-green)}.lsai-video-button:focus-visible{outline:3px solid var(--lsai-green);outline-offset:2px}.lsai-video-play{display:inline-flex;align-items:center;justify-content:center;width:36px;height:36px;border-radius:50%;background:var(--lsai-fill);color:#ffffff;font-size:0.85rem;padding-left:2px}.lsai-video-label{display:flex;flex-direction:column;line-height:1.25;font-size:0.85rem;color:var(--lsai-muted)}.lsai-video-label strong{color:var(--lsai-ink);font-size:0.95rem}.lsai-lightbox.lsai-video-box{cursor:default}.lsai-video-box .lsai-lightbox-note{pointer-events:none}.lsai-video-player{display:block;width:min(1100px, 100%);max-height:calc(100vh - 120px);border-radius:8px;background:#000000;box-shadow:0 12px 40px rgba(0, 0, 0, 0.45)}.lsai-progress{display:grid;grid-template-columns:repeat(5, 1fr);gap:6px;list-style:none;margin:0 0 24px;padding:0}.lsai-progress-item{list-style:none;margin:0}.lsai-progress-bar{display:block;height:4px;border-radius:2px;background:var(--lsai-line);margin-bottom:6px}.lsai-progress-label{display:flex;align-items:center;gap:6px;font-size:0.8rem;color:var(--lsai-muted);line-height:1.3}.lsai-done .lsai-progress-bar{background:var(--lsai-green-line)}.lsai-done .lsai-progress-label{color:var(--lsai-green)}.lsai-current .lsai-progress-bar{background:var(--lsai-green)}.lsai-current .lsai-progress-label{color:var(--lsai-ink);font-weight:700}.lsai-progress-now{display:none;font-size:0.85rem;font-weight:700;color:var(--lsai-ink);margin:-14px 0 20px}.lsai-step{display:flex;gap:16px;align-items:flex-start;padding:18px 0;border-bottom:1px solid var(--lsai-line)}.lsai-step-num{flex:none;width:32px;height:32px;border-radius:50%;background:var(--lsai-fill);color:#ffffff;font-weight:700;display:flex;align-items:center;justify-content:center;margin-top:2px}.lsai-step-main{flex:1;min-width:0}.lsai-step-label{font-size:0.72rem;letter-spacing:0.08em;text-transform:uppercase;color:var(--lsai-muted);font-weight:600}.lsai-step-title{font-size:1.1rem;font-weight:700;margin:2px 0 6px}.lsai-step-text p:last-child{margin-bottom:0}.lsai-thumbs{flex:none;width:190px;display:flex;flex-direction:column;gap:10px}.lsai-thumb{width:100%;text-decoration:none;display:block;cursor:zoom-in}.lsai-lightbox{position:fixed;inset:0;z-index:1000;background:rgba(15, 23, 42, 0.86);display:flex;flex-direction:column;align-items:center;justify-content:center;gap:12px;padding:24px;cursor:zoom-out}.lsai-lightbox img{max-width:min(1280px, 100%);max-height:calc(100vh - 90px);border-radius:8px;box-shadow:0 12px 40px rgba(0, 0, 0, 0.45);background:#ffffff}.lsai-lightbox-note{color:#ffffff;font-size:0.95rem}.lsai-lightbox-close{position:absolute;top:16px;right:16px;background:#ffffff;color:#111827;border:0;border-radius:6px;padding:8px 16px;font-weight:700;font-size:0.95rem;cursor:pointer}.lsai-page td code{white-space:nowrap}.lsai-page div[class*=\"--page-padding:20px\"]{margin-top:4px!important;margin-bottom:8px!important;padding-top:0!important;padding-bottom:0!important}.lsai-route #topbar-cta-button,.lsai-route a[href=\"https://portal.ledgersyncappv2.com\"].whitespace-nowrap,.lsai-route li:has(>a[href=\"https://portal.ledgersyncappv2.com\"].whitespace-nowrap),.lsai-route li.whitespace-nowrap>a[href=\"https://portal.ledgersyncappv2.com\"]{display:none!important}.lsai-thumb img{display:block;width:100%;height:auto;border:1px solid var(--lsai-line);border-radius:6px;margin:0;box-shadow:0 1px 2px rgba(0, 0, 0, 0.06)}.lsai-thumb:hover img{border-color:var(--lsai-green)}.lsai-page a.lsai-thumb,.lsai-page a.lsai-thumb:hover{text-decoration:none!important;border-bottom:0!important}.lsai-page a.lsai-thumb .lsai-thumb-caption{color:var(--lsai-muted)!important;font-weight:400!important;text-decoration:none!important}.lsai-thumb-caption{display:block;font-size:0.75rem;color:var(--lsai-muted);text-align:center;margin-top:4px}.lsai-btn{display:inline-block;background:var(--lsai-fill);color:#ffffff!important;font-weight:600;font-size:0.9rem;border:1px solid var(--lsai-green);border-radius:6px;padding:6px 14px;text-decoration:none!important;cursor:pointer;line-height:1.4}.lsai-btn:hover{background:var(--lsai-fill-hover);border-color:var(--lsai-green-dark)}.lsai-btn-outline{background:transparent;color:var(--lsai-green)!important}.lsai-btn-outline:hover{background:var(--lsai-green-soft)}.lsai-buttons{display:flex;flex-wrap:wrap;gap:8px;margin:8px 0}.lsai-grid-2{display:grid;grid-template-columns:repeat(2, 1fr);gap:12px;margin:0 0 8px}.lsai-grid-3{display:grid;grid-template-columns:repeat(3, 1fr);gap:12px;margin:0 0 8px}@media (min-width: 1024px) and (max-width: 1099px){.lsai-grid-3{grid-template-columns:1fr}}.lsai-choice{display:flex;flex-direction:column;border:1px solid var(--lsai-green-line);border-radius:10px;padding:16px;background:var(--lsai-card)}.lsai-choice-title{font-weight:700;font-size:1.02rem;margin-bottom:4px}.lsai-choice-text{color:var(--lsai-muted);font-size:0.93rem;flex:1}.lsai-choice-text p{margin:0 0 6px}.lsai-choice-action{margin-top:12px}.lsai-note{border-left:4px solid #c3ccd4;background:var(--lsai-gray-soft);border-radius:6px;padding:12px 14px;margin:12px 0;font-size:0.95rem}.lsai-note p:last-child{margin-bottom:0}.lsai-note-green{border-left-color:var(--lsai-green);background:var(--lsai-green-soft)}.lsai-note-yellow{border-left-color:var(--lsai-yellow-line);background:var(--lsai-yellow-soft)}.lsai-note-red{border-left-color:var(--lsai-red-line);background:var(--lsai-red-soft)}.lsai-step-text .lsai-note{margin:8px 0 0;font-size:0.9rem}.lsai-copy{margin:0 0 16px}.lsai-copy-label{font-size:0.85rem;color:var(--lsai-muted);margin-bottom:4px}.lsai-copy-row{display:flex;align-items:center;gap:8px;border:1px solid var(--lsai-line);border-radius:8px;background:var(--lsai-gray-soft);padding:6px 6px 6px 12px}.lsai-copy-text{flex:1;min-width:0;font-family:ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:0.95rem;overflow-wrap:anywhere;background:transparent;padding:0}.lsai-copy-button{flex:none;background:var(--lsai-fill);color:#ffffff;border:0;border-radius:6px;padding:6px 14px;font-weight:600;font-size:0.9rem;cursor:pointer}.lsai-copy-button:hover{background:var(--lsai-fill-hover)}.lsai-prompt .lsai-copy-row{align-items:flex-start}.lsai-prompt .lsai-copy-text{white-space:pre-wrap;line-height:1.5}.lsai-test{display:flex;align-items:center;gap:12px;border:1px solid var(--lsai-green-line);background:var(--lsai-green-soft);border-radius:10px;padding:14px 16px;margin:20px 0}.lsai-test-main{flex:1;min-width:0}.lsai-test-title{font-weight:700}.lsai-test-text{font-style:italic}.lsai-test-more{font-size:1rem;color:var(--lsai-ink);margin-top:6px}.lsai-test-more p:last-child{margin-bottom:0}.lsai-test-button{flex:none}.lsai-box{border:1px solid var(--lsai-line);background:var(--lsai-gray-soft);border-radius:10px;padding:16px;margin:16px 0}.lsai-box-title{font-weight:700;margin-bottom:4px}.lsai-box-text p:last-child{margin-bottom:0}.lsai-page [id]{scroll-margin-top:128px}.lsai-box-thumb{max-width:220px;margin-top:12px}.lsai-badge{display:inline-block;font-size:0.75rem;font-weight:700;line-height:1;padding:4px 8px;border-radius:999px;background:var(--lsai-green-soft);color:var(--lsai-green);vertical-align:middle;margin-left:6px}.lsai-grid-2 .lsai-box{margin:0;background:var(--lsai-card)}.lsai-stuck{border-top:1px solid var(--lsai-line);margin-top:28px;padding-top:14px;font-size:0.88rem;color:var(--lsai-muted)}@media (max-width: 760px){.lsai-page{padding:20px 16px 40px}.lsai-title{font-size:1.6rem}.lsai-grid-2,.lsai-grid-3{grid-template-columns:1fr}.lsai-progress-label{display:none}.lsai-progress-now{display:block}.lsai-step{flex-wrap:wrap}.lsai-step-main{flex-basis:calc(100% - 48px)}.lsai-thumbs{width:calc(100% - 48px);margin-left:48px;max-width:360px}.lsai-test{flex-direction:column;align-items:flex-start}}@media (min-width: 1024px) and (min-height: 600px){.lsai-page.lsai-page-pinned{--lsai-nav-h: calc(var(--mintlify-slot-header-height, calc(4rem + var(--topbar-tabs-height, 3rem))) + var(--banner-height, 0px));padding-top:20px}.lsai-page-pinned .lsai-top{position:sticky;top:var(--lsai-nav-h);z-index:20;margin:0 0 12px;padding:12px 0 11px;background:var(--lsai-bg);border-bottom:1px solid var(--lsai-line)}.lsai-page-pinned .lsai-head{flex-wrap:nowrap}.lsai-page-pinned .lsai-progress{margin-bottom:0}.lsai-page-pinned .lsai-top.lsai-top-stuck{padding-top:8px}.lsai-page-pinned .lsai-top-stuck .lsai-subtitle{display:none}.lsai-page-pinned .lsai-top-stuck .lsai-title{font-size:1.5rem;margin-bottom:0}.lsai-page-pinned .lsai-top-stuck .lsai-head{align-items:center;margin-bottom:8px}.lsai-page-pinned .lsai-top-stuck .lsai-video-button{padding:6px 12px 6px 6px}.lsai-page-pinned .lsai-top-stuck .lsai-video-play{width:28px;height:28px}html:has(.lsai-page-pinned){scroll-padding-top:calc(var(--mintlify-slot-header-height, calc(4rem + var(--topbar-tabs-height, 3rem))) + var(--banner-height, 0px) + var(--lsai-pinned-h, 110px) + 12px)}.lsai-page.lsai-page-pinned [id]{scroll-margin-top:0}.lsai-page-pinned .lsai-top-stuck .lsai-video-button{scroll-margin-top:calc(-1 * (var(--lsai-pinned-h, 110px) + 12px))}html:has(.lsai-page-pinned) :is(#navbar,#sidebar) :is(a,button,input,[tabindex]){scroll-margin-top:calc(-1 * (var(--mintlify-slot-header-height, calc(4rem + var(--topbar-tabs-height, 3rem))) + var(--banner-height, 0px) + var(--lsai-pinned-h, 110px) + 12px))}}"}]}
{"page":{"pagePath":"api-reference/accounts/get-an-account","slug":"/api-reference/accounts/get-an-account","pageMetadata":{"title":"Get an account","description":"Look up a single Account by id. Returns name, type, current\nbalance, mask (at most the last 4 digits of the account number,\non every source), and the Connection it came from.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}","href":"/api-reference/accounts/get-an-account","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Look up a single Account by id. Returns name, type, current\\nbalance, mask (at most the last 4 digits of the account number,\\non every source), and the Connection it came from.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an account","description":"Look up a single Account by id. Returns name, type, current\nbalance, mask (at most the last 4 digits of the account number,\non every source), and the Connection it came from.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}","href":"/api-reference/accounts/get-an-account","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ledgersync/6ae4be936c1d0f9f/ai-connector.js"],"openApiReferenceData":{"operation":{"tags":["Accounts"],"operationId":"getAccount","summary":"Get an account","description":"Look up a single Account by id. Returns name, type, current\nbalance, mask (at most the last 4 digits of the account number,\non every source), and the Connection it came from.\n","parameters":["ae5a5c25-f938-4fb9-bb6e-7d898d99a6b7"],"responses":{"200":"f6375a23-6acb-40ab-8eb9-3e016f839827","401":"10c4ddce-8d92-4b94-969b-d3a179fc0b76","404":"4060372e-5c12-4942-b88c-0cf55cde24a9"},"method":"get","type":"path","servers":["c05434f0-e6f8-417e-89ec-e0c466a58105","1a9bd51d-9aae-48d2-815d-8a7938a9d6a7"],"security":["d8318703-d081-463f-981f-0ec94b99ab84"],"path":"/accounts/{account_id}","baseUrlOptions":["https://api-sandbox.ledgersyncappv2.com/v3","https://api.ledgersyncappv2.com/v3"],"title":"Get an account","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ae5a5c25-f938-4fb9-bb6e-7d898d99a6b7":{"name":"client_id","in":"query","required":true,"description":"The Client (`cli_…`) to scope the read to. Required on account,\ntransaction, and statement reads — LedgerSync's backend data APIs\nare scoped per end-user, so these resources are resolved within a\nsingle Client. Check corrections are scoped the same way.\n","schema":{"type":"string","isRequired":true,"description":"The Client (`cli_…`) to scope the read to. Required on account,\ntransaction, and statement reads — LedgerSync's backend data APIs\nare scoped per end-user, so these resources are resolved within a\nsingle Client. Check corrections are scoped the same way.\n","uniqueKey":"","typeLabel":"string"}},"622fa97b-4592-4a2e-89b9-903ac704fbb4":{"in":"path","name":"account_id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"f6375a23-6acb-40ab-8eb9-3e016f839827":{"description":"The Account.","content":{"application/json":{"schema":{"type":"object","required":["id","source","iso_currency_code","type"],"properties":{"id":{"type":"string","example":"acc_FINICITY_45","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"source":{"type":"string","description":"Financial-data source backing an account. Aggregator sources\n(`FINICITY`, `MX`) and `FDE` back a Connection; `PDF` does not.\n\nValues:\n- `FINICITY` — Finicity aggregation\n- `MX` — MX aggregation\n- `FDE` — Financial Document Extraction (LedgerSync proprietary)\n- `PDF` — Uploaded bank statements. Read-only: exposed on\n `/accounts` and `/transactions` (statements are not served for\n PDF), and never as a Connection (PDF accounts have\n `connection_id: null`).\n","enum":["FINICITY","MX","FDE","PDF"],"x-enum-descriptions":["Finicity aggregation","MX aggregation","Financial Document Extraction (LedgerSync proprietary)","Uploaded bank statements (read-only; not a connection source)"],"isRequired":true,"uniqueKey":"source","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["checking","savings","credit_card","loan","investment","other"],"description":"Coarse account classification, normalized by LedgerSync so the same six values mean the same thing on every source. Always present. `other` means the source did not classify the account, or classified it as something with no home in this enum (a rewards balance, an MX \"other liability\") - read `subtype` to tell those apart. This list is closed and stable; new upstream products appear in `subtype`, never here.","example":"credit_card","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"iso_currency_code":{"type":"string","description":"ISO-4217 currency code. Defaults to USD when the source omits it.","example":"USD","isRequired":true,"uniqueKey":"iso_currency_code","typeLabel":"string"},"connection_id":{"oneOf":[{"type":"string","description":"Owning connection — canonical id (`con_\u003cSOURCE>_\u003cbankAccountId>`). Null on a sandbox single-fetch (a sandbox account id doesn't encode its connection). Always present when listing accounts by connection.","example":"con_FINICITY_41294","uniqueKey":"connection_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Owning connection — canonical id (`con_\u003cSOURCE>_\u003cbankAccountId>`). Null on a sandbox single-fetch (a sandbox account id doesn't encode its connection). Always present when listing accounts by connection.","example":"con_FINICITY_41294","uniqueKey":"connection_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_id","typeLabel":"string | null"},"client_id":{"type":"string","uniqueKey":"client_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"subtype":{"type":"string","pattern":"^[a-z0-9_]+$","description":"The finer label the source reported, before it was collapsed into `type`. Always present. This is an OPEN vocabulary that grows as sources report new products, which is why it is a plain string and not an enum: a new value here is never a breaking change. Branch on `type`; use `subtype` for display, or for finer routing you control and can update. `unknown` when the source reported no type at all, which today is every FDE account and roughly half of the accounts created from uploaded statements. Examples of the collapse: `money_market` and `certificate_of_deposit` report `type: savings`; `mortgage` and `line_of_credit` report `type: loan`; `ira`, `roth` and `plan_401k` report `type: investment`; `bank` reports `type: checking`.","example":"money_market","uniqueKey":"subtype","typeLabel":"string"},"mask":{"oneOf":[{"type":"string","description":"Last 4 digits of the account number (Plaid-style mask), on every source. Never more than 4 digits, fewer when the source holds a shorter number, and null when it holds none.","example":"1234","uniqueKey":"mask.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last 4 digits of the account number (Plaid-style mask), on every source. Never more than 4 digits, fewer when the source holds a shorter number, and null when it holds none.","example":"1234","uniqueKey":"mask.oneOf.1","typeLabel":"null"}],"uniqueKey":"mask","typeLabel":"string | null"},"current_balance":{"oneOf":[{"type":"number","description":"Most recent balance in the account's currency, as a decimal, signed from the account holder's point of view and normalized by LedgerSync so it means the same thing on every source. Positive is value you hold, negative is value you owe, so summing this across a client's accounts gives net worth. A credit card or loan carrying a balance is therefore negative, and a checking account in overdraft is negative too. The sign is meaningful in both directions: an overpaid card with a real credit balance is positive. Null when the source hasn't reported one yet. The `account.refresh.completed` webhook reports the same account with the same sign, wrapped as `{amount, iso_currency_code}` rather than a bare decimal.","example":-1234.56,"uniqueKey":"current_balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Most recent balance in the account's currency, as a decimal, signed from the account holder's point of view and normalized by LedgerSync so it means the same thing on every source. Positive is value you hold, negative is value you owe, so summing this across a client's accounts gives net worth. A credit card or loan carrying a balance is therefore negative, and a checking account in overdraft is negative too. The sign is meaningful in both directions: an overpaid card with a real credit balance is positive. Null when the source hasn't reported one yet. The `account.refresh.completed` webhook reports the same account with the same sign, wrapped as `{amount, iso_currency_code}` rather than a bare decimal.","example":-1234.56,"uniqueKey":"current_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"current_balance","typeLabel":"number | null"},"available_balance":{"oneOf":[{"type":"number","description":"Available balance, when the source distinguishes it from the current balance. On a credit card this is available credit, an amount you can spend, so it is NOT sign-flipped the way `current_balance` is and is normally positive. MX is the only source that reports it, and only for some accounts (common on checking, rare on cards), so it is null far more often than not. Check `realized_capabilities.available_balance` rather than assuming it is present.","uniqueKey":"available_balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"Available balance, when the source distinguishes it from the current balance. On a credit card this is available credit, an amount you can spend, so it is NOT sign-flipped the way `current_balance` is and is normally positive. MX is the only source that reports it, and only for some accounts (common on checking, rare on cards), so it is null far more often than not. Check `realized_capabilities.available_balance` rather than assuming it is present.","uniqueKey":"available_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"available_balance","typeLabel":"number | null"},"last_refreshed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"last_refreshed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"last_refreshed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_refreshed_at","typeLabel":"string\u003cdate-time> | null"},"oldest_transaction_date":{"oneOf":[{"type":"string","format":"date","description":"How far back our transaction history for this account actually goes: the `date` of the oldest transaction we hold. It is the minimum `date` you will see if you page this account's entire history through `GET /accounts/{account_id}/transactions`. Measured from the transactions we hold, not a claim by the aggregator about what it could supply. Null means we hold no transactions for this account at all, which is normal for one that was linked but has not completed a first refresh. It moves backwards, never forwards, when a backfill lands, and it is not a promise about what a future refresh will retrieve.","example":"2023-04-11","uniqueKey":"oldest_transaction_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"How far back our transaction history for this account actually goes: the `date` of the oldest transaction we hold. It is the minimum `date` you will see if you page this account's entire history through `GET /accounts/{account_id}/transactions`. Measured from the transactions we hold, not a claim by the aggregator about what it could supply. Null means we hold no transactions for this account at all, which is normal for one that was linked but has not completed a first refresh. It moves backwards, never forwards, when a backfill lands, and it is not a promise about what a future refresh will retrieve.","example":"2023-04-11","uniqueKey":"oldest_transaction_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"oldest_transaction_date","typeLabel":"string\u003cdate> | null"},"liabilities":{"oneOf":[{"type":"object","description":"Credit terms for this account: what the client can borrow,\nwhat they owed at the last statement close, how much of that is\nstill unpaid, and what the bank wants next. Present only on\nliability accounts: credit cards,\nlines of credit, loans and mortgages. Null on every other account\n(checking, savings, investment), even when the source reports\nterms for it, and also on liability accounts at institutions that\ndo not report these values, so its presence is itself the signal\nthat anything is known. Individual fields inside it are\nindependently nullable for the same reason.\n","properties":{"credit_limit":{"oneOf":[{"type":"number","description":"The account's total credit line, as a positive amount.","example":65000,"uniqueKey":"liabilities.oneOf.0.credit_limit.oneOf.0","typeLabel":"number"},{"type":"null","description":"The account's total credit line, as a positive amount.","example":65000,"uniqueKey":"liabilities.oneOf.0.credit_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.credit_limit","typeLabel":"number | null"},"available_credit":{"oneOf":[{"type":"number","description":"Credit still available to draw on, as a positive amount. Typically the credit limit minus the current balance, computed by the bank rather than by us, so it may not reconcile exactly against `current_balance` at any given instant.","example":50596.54,"uniqueKey":"liabilities.oneOf.0.available_credit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Credit still available to draw on, as a positive amount. Typically the credit limit minus the current balance, computed by the bank rather than by us, so it may not reconcile exactly against `current_balance` at any given instant.","example":50596.54,"uniqueKey":"liabilities.oneOf.0.available_credit.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.available_credit","typeLabel":"number | null"},"statement_balance":{"oneOf":[{"type":"number","description":"The amount owed at the last statement close, NEGATIVE like every other amount owed in this API, so it agrees in sign with `current_balance` on the same account. This is a normalized magnitude: institutions disagree with each other on the sign of this figure, several of them reporting a debt as positive while reporting the same debt as a negative account balance, so passing the reported sign through would make the field unusable. One consequence is that a card that was in credit at statement close, because the holder overpaid, is reported as owed. It is the balance printed on that statement, so it does not change when a payment posts; `remaining_statement_balance` does.","example":-14381.66,"uniqueKey":"liabilities.oneOf.0.statement_balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"The amount owed at the last statement close, NEGATIVE like every other amount owed in this API, so it agrees in sign with `current_balance` on the same account. This is a normalized magnitude: institutions disagree with each other on the sign of this figure, several of them reporting a debt as positive while reporting the same debt as a negative account balance, so passing the reported sign through would make the field unusable. One consequence is that a card that was in credit at statement close, because the holder overpaid, is reported as owed. It is the balance printed on that statement, so it does not change when a payment posts; `remaining_statement_balance` does.","example":-14381.66,"uniqueKey":"liabilities.oneOf.0.statement_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.statement_balance","typeLabel":"number | null"},"statement_date":{"oneOf":[{"type":"string","format":"date","description":"The day the statement behind `statement_balance` closed, matching that statement's `statement_date` in [`GET /accounts/{account_id}/statements`](#operation/listStatements). Credit cards only. Set only when a statement we hold prints exactly `statement_balance`, so it is null for a few days after each close, while the bank already reports the new statement balance but the statement itself has not reached us yet, and on cards with no statements on file.","example":"2026-08-28","uniqueKey":"liabilities.oneOf.0.statement_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The day the statement behind `statement_balance` closed, matching that statement's `statement_date` in [`GET /accounts/{account_id}/statements`](#operation/listStatements). Credit cards only. Set only when a statement we hold prints exactly `statement_balance`, so it is null for a few days after each close, while the bank already reports the new statement balance but the statement itself has not reached us yet, and on cards with no statements on file.","example":"2026-08-28","uniqueKey":"liabilities.oneOf.0.statement_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.statement_date","typeLabel":"string\u003cdate> | null"},"remaining_statement_balance":{"oneOf":[{"type":"number","description":"What is still unpaid on that statement, NEGATIVE like `statement_balance`, and 0 once it is paid off or when the statement closed in credit. It is `statement_balance` minus every payment, refund and other credit posted after `statement_date`, and never more than the card owes in total (`current_balance`). Pending payments count once they post. No bank or aggregator reports this figure, so LedgerSync computes it. Null exactly when `statement_date` is null.","example":-9381.66,"uniqueKey":"liabilities.oneOf.0.remaining_statement_balance.oneOf.0","typeLabel":"number"},{"type":"null","description":"What is still unpaid on that statement, NEGATIVE like `statement_balance`, and 0 once it is paid off or when the statement closed in credit. It is `statement_balance` minus every payment, refund and other credit posted after `statement_date`, and never more than the card owes in total (`current_balance`). Pending payments count once they post. No bank or aggregator reports this figure, so LedgerSync computes it. Null exactly when `statement_date` is null.","example":-9381.66,"uniqueKey":"liabilities.oneOf.0.remaining_statement_balance.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.remaining_statement_balance","typeLabel":"number | null"},"minimum_payment":{"oneOf":[{"type":"number","description":"The minimum the bank requires by `payment_due_date`, as a positive amount.","example":143,"uniqueKey":"liabilities.oneOf.0.minimum_payment.oneOf.0","typeLabel":"number"},{"type":"null","description":"The minimum the bank requires by `payment_due_date`, as a positive amount.","example":143,"uniqueKey":"liabilities.oneOf.0.minimum_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.minimum_payment","typeLabel":"number | null"},"payment_due_date":{"oneOf":[{"type":"string","format":"date","description":"When the next payment is due. This is the bank's own figure and it is only as current as the last refresh: a bank that has not yet published a new cycle will still be reporting the previous one, so a date in the past means the cycle has rolled over and we have not seen the new one, not that a payment is overdue. Check `last_refreshed_at` before acting on it.","example":"2026-09-24","uniqueKey":"liabilities.oneOf.0.payment_due_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"When the next payment is due. This is the bank's own figure and it is only as current as the last refresh: a bank that has not yet published a new cycle will still be reporting the previous one, so a date in the past means the cycle has rolled over and we have not seen the new one, not that a payment is overdue. Check `last_refreshed_at` before acting on it.","example":"2026-09-24","uniqueKey":"liabilities.oneOf.0.payment_due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities.oneOf.0.payment_due_date","typeLabel":"string\u003cdate> | null"}},"uniqueKey":"liabilities.oneOf.0","typeLabel":"object"},{"type":"null","description":"Credit terms for this account: what the client can borrow,\nwhat they owed at the last statement close, how much of that is\nstill unpaid, and what the bank wants next. Present only on\nliability accounts: credit cards,\nlines of credit, loans and mortgages. Null on every other account\n(checking, savings, investment), even when the source reports\nterms for it, and also on liability accounts at institutions that\ndo not report these values, so its presence is itself the signal\nthat anything is known. Individual fields inside it are\nindependently nullable for the same reason.\n","uniqueKey":"liabilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"liabilities","typeLabel":"object | null"},"realized_capabilities":{"oneOf":[{"type":"object","description":"Per-account observed outcome of the most recent attempt at\neach capability. Today the backend tracks status at the\nbank level — accounts within the same connection share this\nsnapshot. Per-account divergence (one account in a\nconnection failed but others succeeded) requires a backend\nextension and is deferred.\n","required":["transactions","balance","available_balance","statements","check_images"],"properties":{"transactions":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Observed outcome of the most recent attempt at a capability.\n`succeeded` — last attempt delivered data; `last_success_at` is\npopulated. `failed` — last attempt errored; `last_error` carries\nthe source-translated diagnostic. `skipped` — capability not\nattempted this cycle (catch-up exhausted, integrator opt-out).\n`unsupported` — matching `expected_capabilities` promise is\n`never`; entry is still emitted so integrators don't have to\ndisambiguate \"missing means unsupported\" from \"not yet\nattempted\". `pending` — initial sync running or attempt\nin flight.\n","enum":["succeeded","failed","skipped","unsupported","pending"],"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.status","typeLabel":"enum\u003cstring>"},"last_success_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_success_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_success_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_success_at","typeLabel":"string\u003cdate-time> | null"},"next_refresh_after":{"oneOf":[{"type":"string","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.transactions.next_refresh_after.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.transactions.next_refresh_after.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.transactions.next_refresh_after","typeLabel":"string\u003cdate-time> | null"},"last_error":{"oneOf":[{"type":"object","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.transactions.last_error","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.transactions","typeLabel":"object"},"balance":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Observed outcome of the most recent attempt at a capability.\n`succeeded` — last attempt delivered data; `last_success_at` is\npopulated. `failed` — last attempt errored; `last_error` carries\nthe source-translated diagnostic. `skipped` — capability not\nattempted this cycle (catch-up exhausted, integrator opt-out).\n`unsupported` — matching `expected_capabilities` promise is\n`never`; entry is still emitted so integrators don't have to\ndisambiguate \"missing means unsupported\" from \"not yet\nattempted\". `pending` — initial sync running or attempt\nin flight.\n","enum":["succeeded","failed","skipped","unsupported","pending"],"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.status","typeLabel":"enum\u003cstring>"},"last_success_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.balance.last_success_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.balance.last_success_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.balance.last_success_at","typeLabel":"string\u003cdate-time> | null"},"next_refresh_after":{"oneOf":[{"type":"string","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.balance.next_refresh_after.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.balance.next_refresh_after.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.balance.next_refresh_after","typeLabel":"string\u003cdate-time> | null"},"last_error":{"oneOf":[{"type":"object","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","uniqueKey":"realized_capabilities.oneOf.0.balance.last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.balance.last_error","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.balance","typeLabel":"object"},"available_balance":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Observed outcome of the most recent attempt at a capability.\n`succeeded` — last attempt delivered data; `last_success_at` is\npopulated. `failed` — last attempt errored; `last_error` carries\nthe source-translated diagnostic. `skipped` — capability not\nattempted this cycle (catch-up exhausted, integrator opt-out).\n`unsupported` — matching `expected_capabilities` promise is\n`never`; entry is still emitted so integrators don't have to\ndisambiguate \"missing means unsupported\" from \"not yet\nattempted\". `pending` — initial sync running or attempt\nin flight.\n","enum":["succeeded","failed","skipped","unsupported","pending"],"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.status","typeLabel":"enum\u003cstring>"},"last_success_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_success_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_success_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_success_at","typeLabel":"string\u003cdate-time> | null"},"next_refresh_after":{"oneOf":[{"type":"string","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.available_balance.next_refresh_after.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.available_balance.next_refresh_after.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.available_balance.next_refresh_after","typeLabel":"string\u003cdate-time> | null"},"last_error":{"oneOf":[{"type":"object","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.available_balance.last_error","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.available_balance","typeLabel":"object"},"statements":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Observed outcome of the most recent attempt at a capability.\n`succeeded` — last attempt delivered data; `last_success_at` is\npopulated. `failed` — last attempt errored; `last_error` carries\nthe source-translated diagnostic. `skipped` — capability not\nattempted this cycle (catch-up exhausted, integrator opt-out).\n`unsupported` — matching `expected_capabilities` promise is\n`never`; entry is still emitted so integrators don't have to\ndisambiguate \"missing means unsupported\" from \"not yet\nattempted\". `pending` — initial sync running or attempt\nin flight.\n","enum":["succeeded","failed","skipped","unsupported","pending"],"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.status","typeLabel":"enum\u003cstring>"},"last_success_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.statements.last_success_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.statements.last_success_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.statements.last_success_at","typeLabel":"string\u003cdate-time> | null"},"next_refresh_after":{"oneOf":[{"type":"string","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.statements.next_refresh_after.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.statements.next_refresh_after.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.statements.next_refresh_after","typeLabel":"string\u003cdate-time> | null"},"last_error":{"oneOf":[{"type":"object","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","uniqueKey":"realized_capabilities.oneOf.0.statements.last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.statements.last_error","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.statements","typeLabel":"object"},"check_images":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Observed outcome of the most recent attempt at a capability.\n`succeeded` — last attempt delivered data; `last_success_at` is\npopulated. `failed` — last attempt errored; `last_error` carries\nthe source-translated diagnostic. `skipped` — capability not\nattempted this cycle (catch-up exhausted, integrator opt-out).\n`unsupported` — matching `expected_capabilities` promise is\n`never`; entry is still emitted so integrators don't have to\ndisambiguate \"missing means unsupported\" from \"not yet\nattempted\". `pending` — initial sync running or attempt\nin flight.\n","enum":["succeeded","failed","skipped","unsupported","pending"],"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.status","typeLabel":"enum\u003cstring>"},"last_success_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_success_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent successful delivery, when known.","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_success_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_success_at","typeLabel":"string\u003cdate-time> | null"},"next_refresh_after":{"oneOf":[{"type":"string","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.check_images.next_refresh_after.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Earliest moment the next attempt is expected to fire.\nNull when no further attempt is scheduled (e.g. `unsupported`).\n","uniqueKey":"realized_capabilities.oneOf.0.check_images.next_refresh_after.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.check_images.next_refresh_after","typeLabel":"string\u003cdate-time> | null"},"last_error":{"oneOf":[{"type":"object","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Source-translated error from the most recent failed attempt.\nSame shape as the top-level `ErrorInfo` envelope; only\npopulated when `status=failed`.\n","uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities.oneOf.0.check_images.last_error","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"realized_capabilities.oneOf.0.check_images","typeLabel":"object"}},"uniqueKey":"realized_capabilities.oneOf.0","typeLabel":"object"},{"type":"null","description":"Per-account observed outcome of the most recent attempt at\neach capability. Today the backend tracks status at the\nbank level — accounts within the same connection share this\nsnapshot. Per-account divergence (one account in a\nconnection failed but others succeeded) requires a backend\nextension and is deferred.\n","uniqueKey":"realized_capabilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"When LedgerSync first stored this account, which is when we\nfirst saw it at the source. For accounts present at link time\nthis tracks the connection; for one shared later it is when it\narrived. There is no `account.added` webhook, so this is the\nfield to sort or diff on when you re-list accounts to find what\nis new. It never moves afterwards.\n","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When LedgerSync first stored this account, which is when we\nfirst saw it at the source. For accounts present at link time\nthis tracks the connection; for one shared later it is when it\narrived. There is no `account.added` webhook, so this is the\nfield to sort or diff on when you re-list accounts to find what\nis new. It never moves afterwards.\n","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"acc_FINICITY_45","source":"FINICITY","type":"credit_card","iso_currency_code":"USD","connection_id":"con_FINICITY_41294","client_id":"\u003cstring>","name":"\u003cstring>","subtype":"money_market","mask":"1234","current_balance":-1234.56,"available_balance":123,"last_refreshed_at":"2023-11-07T05:31:56Z","oldest_transaction_date":"2023-04-11","liabilities":{"credit_limit":65000,"available_credit":50596.54,"statement_balance":-14381.66,"statement_date":"2026-08-28","remaining_statement_balance":-9381.66,"minimum_payment":143,"payment_due_date":"2026-09-24"},"realized_capabilities":{"transactions":{"status":"succeeded","last_success_at":"2023-11-07T05:31:56Z","next_refresh_after":"2023-11-07T05:31:56Z","last_error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}},"balance":{"status":"succeeded","last_success_at":"2023-11-07T05:31:56Z","next_refresh_after":"2023-11-07T05:31:56Z","last_error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}},"available_balance":{"status":"succeeded","last_success_at":"2023-11-07T05:31:56Z","next_refresh_after":"2023-11-07T05:31:56Z","last_error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}},"statements":{"status":"succeeded","last_success_at":"2023-11-07T05:31:56Z","next_refresh_after":"2023-11-07T05:31:56Z","last_error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}},"check_images":{"status":"succeeded","last_success_at":"2023-11-07T05:31:56Z","next_refresh_after":"2023-11-07T05:31:56Z","last_error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}}},"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"10c4ddce-8d92-4b94-969b-d3a179fc0b76":{"description":"Either the `Authorization` header is missing or the bearer\ntoken doesn't match an active API key. Double-check the key\nand the environment — sandbox keys can't be used against the\nproduction base URL and vice versa.\n","headers":{"X-LS-Trace-Id":{"description":"Distributed-trace ID for this request. Quote in support tickets.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned as the top-level body of every non-2xx\nHTTP response. The actual error payload lives in the `error`\nfield — branch on `error.code`.\n","required":["error"],"properties":{"error":{"type":"object","description":"The inner error payload. Used as the top-level body of an\nHTTP error response (wrapped in `ErrorEnvelope`) and as the\nembedded `error` field on resources that record a failure\n(like `Operation.error`).\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"error.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"error.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"error.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"error.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"error.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"4060372e-5c12-4942-b88c-0cf55cde24a9":{"description":"We didn't find a resource matching the path parameters. Common\ncauses: the id belongs to a different customer's key, the\nresource was deleted, or there's a typo in the id.\n","headers":{"X-LS-Trace-Id":{"description":"Distributed-trace ID for this request. Quote in support tickets.","schema":{"type":"string","example":"4bf92f3577b34da6a3ce929d0e0e4736"}}},"content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned as the top-level body of every non-2xx\nHTTP response. The actual error payload lives in the `error`\nfield — branch on `error.code`.\n","required":["error"],"properties":{"error":{"type":"object","description":"The inner error payload. Used as the top-level body of an\nHTTP error response (wrapped in `ErrorEnvelope`) and as the\nembedded `error` field on resources that record a failure\n(like `Operation.error`).\n","required":["code","message","type"],"properties":{"code":{"type":"string","description":"Stable machine-readable identifier. Branch on this in\nyour code, not on `message`.\n","example":"unknown_api_key","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Plain-English explanation safe to log.","example":"The API key you presented doesn't match any active key.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Stripe-style broad failure-mode category — useful for\n\"treat all of these the same way\" branches. Derived\nfrom the HTTP status. Orthogonal to `category`, which\nclassifies by origin.\n","enum":["auth_error","invalid_request","rate_limit_error","idempotency_error","not_found","api_error"],"example":"auth_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"Link to the docs page for this specific error code.\nShareable with teammates in support tickets.\n","example":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"category":{"type":"string","description":"Plaid-style coarse classification by origin. Branch on\nthis for routing logic — retry the request, surface to\nthe end user in the widget, or page on-call. Orthogonal\nto `type` (which is HTTP-status-derived).\n","enum":["AUTH_ERROR","INSTITUTION_ERROR","CAPABILITY_UNAVAILABLE","CONNECTION_ERROR","RATE_LIMIT","INVALID_REQUEST","RESOURCE_NOT_FOUND","PLATFORM_ERROR"],"example":"AUTH_ERROR","uniqueKey":"error.category","typeLabel":"enum\u003cstring>"},"is_user_actionable":{"type":"boolean","description":"True when the end user can resolve this error (re-enter\ncredentials, complete MFA, accept an updated\nagreement). False when the error requires\ninstitution-side or LS platform-side action. Useful for\ndeciding whether to send the end user back to the\nwidget or surface an \"operational issue\" banner.\n","example":true,"uniqueKey":"error.is_user_actionable","typeLabel":"boolean"},"source_diagnostic_code":{"type":"string","pattern":"^(FIN|MX|FDE)-[A-Z0-9_]+$","description":"Opaque upstream-source diagnostic identifier (e.g.\n`FIN-103`, `MX-DENIED`). Present only on errors that\noriginated at an aggregator/extractor. Use for support\ntriage — do NOT branch on this value; the unified\n`code` and `category` are the integrator-facing\nvocabulary.\n","example":"FIN-103","uniqueKey":"error.source_diagnostic_code","typeLabel":"string"},"param":{"type":"string","description":"On every 400 or 413 that is about one request field\n(`validation_failed` and `invalid_request` alike), the\nfield that tripped the check. Dot-separated path for\nnested fields, with array positions in brackets\n(`line.amount`, `items[1].amount`). Absent on errors that\nare not about a field (auth, not found, upstream faults).\nWhen the body itself could not be parsed there is no one\nfield to blame: most endpoints omit `param`, and the few\nthat parse the body themselves report the literal `body`.\n","example":"client.email","uniqueKey":"error.param","typeLabel":"string"},"trace_id":{"type":"string","description":"Same as the `X-LS-Trace-Id` response header — paste in\na support ticket to jump to the request.\n","example":"4bf92f3577b34da6a3ce929d0e0e4736","uniqueKey":"error.trace_id","typeLabel":"string"},"errors":{"type":"array","description":"Per-field validation errors (only present on 400 when\nmultiple fields failed at once).\n","items":{"type":"object","required":["param","message"],"properties":{"param":{"type":"string","example":"client.email","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unknown_api_key","message":"The API key you presented doesn't match any active key.","type":"auth_error","doc_url":"https://portal.ledgersyncappv2.com/errors/unknown_api_key","category":"AUTH_ERROR","is_user_actionable":true,"source_diagnostic_code":"FIN-103","param":"client.email","trace_id":"4bf92f3577b34da6a3ce929d0e0e4736","errors":[{"param":"client.email","message":"must be a valid email address","code":"invalid_email"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d8318703-d081-463f-981f-0ec94b99ab84":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"LedgerSync API key","description":"Pass your secret key in the `Authorization` header as a Bearer\ntoken: `Authorization: Bearer sk_test_...` (sandbox) or\n`Bearer sk_live_...` (production).\n\nKeys are created in the developer portal and the plaintext\nsecret is shown exactly once at creation. Treat them like\npasswords — never embed them in mobile apps or front-end code.\n","scopes":[],"schemeName":"bearer"}}},"servers":{"c05434f0-e6f8-417e-89ec-e0c466a58105":{"url":"https://api-sandbox.ledgersyncappv2.com/v3","description":"Sandbox — use `sk_test_...` keys from the developer portal. Routes to the real Finicity and MX sandbox banks (FinBank, mxbank) via the same connector code paths as production."},"1a9bd51d-9aae-48d2-815d-8a7938a9d6a7":{"url":"https://api.ledgersyncappv2.com/v3","description":"Production — use `sk_live_...` keys. Hits real banks via Finicity, MX, or FDE depending on the connection."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"LedgerSync API key","description":"Pass your secret key in the `Authorization` header as a Bearer\ntoken: `Authorization: Bearer sk_test_...` (sandbox) or\n`Bearer sk_live_...` (production).\n\nKeys are created in the developer portal and the plaintext\nsecret is shown exactly once at creation. Treat them like\npasswords — never embed them in mobile apps or front-end code.\n","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Pass your secret key in the `Authorization` header as a Bearer\ntoken: `Authorization: Bearer sk_test_...` (sandbox) or\n`Bearer sk_live_...` (production).\n\nKeys are created in the developer portal and the plaintext\nsecret is shown exactly once at creation. Treat them like\npasswords — never embed them in mobile apps or front-end code.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"ledgersync","siteName":"LedgerSync","title":"Get an account - LedgerSync","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T23:35:19.861Z","originalFileLocation":"api-reference/accounts/get-an-account.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Look up a single Account by id. Returns name, type, current balance, mask (at most the last 4 digits of the account number, on every source), and the Connection it came from.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LedgerSync\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an account - LedgerSync\">\u003cmeta data-mint-head property=\"og:description\" content=\"Look up a single Account by id. Returns name, type, current balance, mask (at most the last 4 digits of the account number, on every source), and the Connection it came from.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LedgerSync\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ledgersync.mintlify.site/_mintlify/api/og/v2?division=Accounts\u0026amp;title=Get+an+account\u0026amp;description=Look+up+a+single+Account+by+id.+Returns+name%2C+type%2C+current%0Abalance%2C+mask+%28at+most+the+last+4+digits+of+the+account+number%2C%0Aon+every+source%29%2C+and+the+Connection\u0026amp;theme=bcd469bc79d7c9d0510611ec\u0026amp;signature=a09b34119ec2b966cc9fa6d8517c080e9c953295463c04c95e2f747ad4c08608\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get an account - LedgerSync\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Look up a single Account by id. Returns name, type, current balance, mask (at most the last 4 digits of the account number, on every source), and the Connection it came from.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ledgersync.mintlify.site/_mintlify/api/og/v2?division=Accounts\u0026amp;title=Get+an+account\u0026amp;description=Look+up+a+single+Account+by+id.+Returns+name%2C+type%2C+current%0Abalance%2C+mask+%28at+most+the+last+4+digits+of+the+account+number%2C%0Aon+every+source%29%2C+and+the+Connection\u0026amp;theme=bcd469bc79d7c9d0510611ec\u0026amp;signature=a09b34119ec2b966cc9fa6d8517c080e9c953295463c04c95e2f747ad4c08608\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ledgersync/_Z9OSrCeUvX_nsj4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LedgerSync\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0891B2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/accounts/get-an-account.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ledgersyncappv2.com/#organization\",\"name\":\"LedgerSync\",\"url\":\"https://docs.ledgersyncappv2.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ledgersync/NVbCdX0lsP_TgYmH/logo/ledgersync-wordmark.png?fit=max\u0026auto=format\u0026n=NVbCdX0lsP_TgYmH\u0026q=85\u0026s=b149d57dc2f40804f937b11e31060496\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ledgersyncappv2.com#website\",\"name\":\"LedgerSync\",\"url\":\"https://docs.ledgersyncappv2.com\",\"publisher\":{\"@id\":\"https://docs.ledgersyncappv2.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account#webpage\",\"url\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account\",\"name\":\"Get an account\",\"description\":\"Look up a single Account by id. Returns name, type, current balance, mask (at most the last 4 digits of the account number, on every source), and the Connection it came from.\",\"dateModified\":\"2026-11-20T23:35:19.861Z\",\"isPartOf\":{\"@id\":\"https://docs.ledgersyncappv2.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accounts\",\"item\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/list-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an account\",\"item\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account#apireference\",\"headline\":\"Get an account\",\"name\":\"Get an account\",\"description\":\"Look up a single Account by id. Returns name, type, current balance, mask (at most the last 4 digits of the account number, on every source), and the Connection it came from.\",\"url\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/accounts/get-an-account#webpage\"},\"dateModified\":\"2026-11-20T23:35:19.861Z\",\"publisher\":{\"@id\":\"https://docs.ledgersyncappv2.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ledgersyncappv2.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LedgerSync\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LedgerSync\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/accounts/get-an-account.md","siteName":"LedgerSync","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"LedgerSync MCP","pages":[{"title":"LedgerSync MCP","href":"/ai/start-here"}]},{"tab":"API Reference","groups":[{"group":"Get started","pages":[{"title":"API reference","sidebarTitle":"Overview","href":"/api-reference/overview"}]},{"group":"Health","pages":[{"title":"Service health check","deprecated":null,"version":null,"openapi":"/openapi.yaml get /health","href":"/api-reference/health/service-health-check"}]},{"group":"Clients","pages":[{"title":"List clients","deprecated":null,"version":null,"openapi":"/openapi.yaml get /clients","href":"/api-reference/clients/list-clients"},{"title":"Create a client","deprecated":null,"version":null,"openapi":"/openapi.yaml post /clients","href":"/api-reference/clients/create-a-client"},{"title":"Get a client","deprecated":null,"version":null,"openapi":"/openapi.yaml get /clients/{client_id}","href":"/api-reference/clients/get-a-client"},{"title":"Delete a client and everything attached","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /clients/{client_id}","href":"/api-reference/clients/delete-a-client-and-everything-attached"},{"title":"Update a client","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /clients/{client_id}","href":"/api-reference/clients/update-a-client"},{"title":"Mint a short-lived end-user token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /clients/{client_id}/end-user-token","href":"/api-reference/clients/mint-a-short-lived-end-user-token"},{"title":"Create a hosted pick-and-connect link for a client","deprecated":null,"version":null,"openapi":"/openapi.yaml post /clients/{client_id}/connect-session","href":"/api-reference/clients/create-a-hosted-pick-and-connect-link-for-a-client"},{"title":"Revoke a hosted connect link","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /clients/{client_id}/connect-session/{sid}","href":"/api-reference/clients/revoke-a-hosted-connect-link"}]},{"group":"Connections","pages":[{"title":"List a client's connections","deprecated":null,"version":null,"openapi":"/openapi.yaml get /clients/{client_id}/connections","href":"/api-reference/connections/list-a-clients-connections"},{"title":"Open a bank connection session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /clients/{client_id}/connections","href":"/api-reference/connections/open-a-bank-connection-session"},{"title":"Get a connection","deprecated":null,"version":null,"openapi":"/openapi.yaml get /connections/{connection_id}","href":"/api-reference/connections/get-a-connection"},{"title":"Disconnect and remove a connection","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /connections/{connection_id}","href":"/api-reference/connections/disconnect-and-remove-a-connection"},{"title":"Refresh a connection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /connections/{connection_id}/refresh","href":"/api-reference/connections/refresh-a-connection"},{"title":"Reauthorize a connection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /connections/{connection_id}/reauthorize","href":"/api-reference/connections/reauthorize-a-connection"},{"title":"Verify a redirect-token (ls_token) from the post-Connect callback","deprecated":null,"version":null,"openapi":"/openapi.yaml post /connections/redirect-token/verify","href":"/api-reference/connections/verify-a-redirect-token-ls_token-from-the-post-connect-callback"},{"title":"LedgerSync-hosted MX Connect wrapper page (browser-facing)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /connections/mx-wrapper","href":"/api-reference/connections/ledgersync-hosted-mx-connect-wrapper-page-browser-facing"},{"title":"LedgerSync-hosted pick-and-connect page (browser-facing)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /connect-session","href":"/api-reference/connections/ledgersync-hosted-pick-and-connect-page-browser-facing"}]},{"group":"Settings","pages":[{"title":"Read the redirect-URL allowlist for the current account + environment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /settings/redirect-urls","href":"/api-reference/settings/read-the-redirect-url-allowlist-for-the-current-account-+-environment"},{"title":"Replace the redirect-URL allowlist for the current account + environment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /settings/redirect-urls","href":"/api-reference/settings/replace-the-redirect-url-allowlist-for-the-current-account-+-environment"},{"title":"Delete the redirect-URL allowlist row for the current account + environment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /settings/redirect-urls","href":"/api-reference/settings/delete-the-redirect-url-allowlist-row-for-the-current-account-+-environment"}]},{"group":"Institutions","pages":[{"title":"List or search the unified institution catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /institutions","href":"/api-reference/institutions/list-or-search-the-unified-institution-catalog"},{"title":"Get one institution by v3 catalog id","deprecated":null,"version":null,"openapi":"/openapi.yaml get /institutions/{id}","href":"/api-reference/institutions/get-one-institution-by-v3-catalog-id"}]},{"group":"Accounts","pages":[{"title":"List accounts","description":"List every Account across all of your Clients. Filter to one\nClient, one Connection, or one source if you only want a\nsubset. Balances on each Account reflect the most recent\nrefresh — check `last_refreshed_at` to see how fresh that is.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}","href":"/api-reference/accounts/get-an-account"}]},{"group":"Transactions","pages":[{"title":"List transactions for an account","description":"Page through an account's transactions, optionally filtered\nby date range. Pending and posted are both included — check\nthe `pending` boolean. New transactions land here after each\nrefresh (auto-daily or your manual `POST /refresh` call);\na future push-delivery event for transactions will be offered\nfor push consumers.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}/transactions","href":"/api-reference/transactions/list-transactions-for-an-account"},{"title":"Get a single transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transactions/{transaction_id}","href":"/api-reference/transactions/get-a-single-transaction"}]},{"group":"Statements","pages":[{"title":"List an account's statements","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}/statements","href":"/api-reference/statements/list-an-accounts-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /statements/{statement_id}","href":"/api-reference/statements/get-a-statement"},{"title":"Extract transactions from an uploaded bank-statement PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml post /statements/extract","href":"/api-reference/statements/extract-transactions-from-an-uploaded-bank-statement-pdf"},{"title":"Download the statement PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /statements/{statement_id}/download","href":"/api-reference/statements/download-the-statement-pdf"}]},{"group":"Checks","pages":[{"title":"List an account's check images","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}/checks","href":"/api-reference/checks/list-an-accounts-check-images"},{"title":"Get a check","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}/checks/{check_id}","href":"/api-reference/checks/get-a-check"},{"title":"Correct a check's OCR readings","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{account_id}/checks/{check_id}","href":"/api-reference/checks/correct-a-checks-ocr-readings"},{"title":"Download the check image","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{account_id}/checks/{check_id}/download","href":"/api-reference/checks/download-the-check-image"}]},{"group":"Operations","pages":[{"title":"Check on an async operation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /operations/{operation_id}","href":"/api-reference/operations/check-on-an-async-operation"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/subscriptions","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/subscriptions","href":"/api-reference/webhooks/create-a-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/get-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /webhooks/subscriptions/{subscription_id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/subscriptions/{subscription_id}/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/subscriptions/{subscription_id}/test","href":"/api-reference/webhooks/send-a-test-event"}]},{"group":"ApiKeys","pages":[{"title":"List your API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api-keys","href":"/api-reference/apikeys/list-your-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api-keys","href":"/api-reference/apikeys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api-keys/{api_key_id}","href":"/api-reference/apikeys/revoke-an-api-key"},{"title":"Change an API key's scopes","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /api-keys/{api_key_id}","href":"/api-reference/apikeys/change-an-api-keys-scopes"}]},{"group":"Sandbox","pages":[{"title":"List sandbox-eligible test banks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sandbox/institutions","href":"/api-reference/sandbox/list-sandbox-eligible-test-banks"}]},{"group":"Metrics","pages":[{"title":"Headline counts for the portal tile grid","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/summary","href":"/api-reference/metrics/headline-counts-for-the-portal-tile-grid"},{"title":"Connection counts broken down by health state","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/connection-health","href":"/api-reference/metrics/connection-counts-broken-down-by-health-state"},{"title":"Bucketed time-series for one metric","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/time-series","href":"/api-reference/metrics/bucketed-time-series-for-one-metric"},{"title":"Top-N institutions ranked by count or failure rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/top-institutions","href":"/api-reference/metrics/top-n-institutions-ranked-by-count-or-failure-rate"},{"title":"API request volume, error rate, and latency percentiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/api-usage","href":"/api-reference/metrics/api-request-volume-error-rate-and-latency-percentiles"},{"title":"Webhook delivery volume, success rate, and latency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/webhook-delivery","href":"/api-reference/metrics/webhook-delivery-volume-success-rate-and-latency"}]},{"group":"PortalGating","pages":[{"title":"Submit a sandbox access request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portal/access-request","href":"/api-reference/portalgating/submit-a-sandbox-access-request"},{"title":"Submit a live-environment access request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /portal/live-request","href":"/api-reference/portalgating/submit-a-live-environment-access-request"},{"title":"Edit a live application while still under review","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /portal/live-request","href":"/api-reference/portalgating/edit-a-live-application-while-still-under-review"},{"title":"Read the gating status for the signed-in user","deprecated":null,"version":null,"openapi":"/openapi.yaml get /portal/access-request/status","href":"/api-reference/portalgating/read-the-gating-status-for-the-signed-in-user"}]}]},{"tab":"v2 API (legacy)","pages":[{"title":"v2 API (legacy)","href":"/v2/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get an account - LedgerSync","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}