{ "id": "con_FINICITY_41294", "client_id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0", "source": "FINICITY", "status": "initiated", "created_at": "2023-11-07T05:31:56Z", "institution": { "id": "<string>", "name": "Chase", "logo_url": "<string>" }, "last_refreshed_at": "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" } ] }, "expected_capabilities": { "transactions": { "promise": "always" }, "balance": { "promise": "always" }, "available_balance": { "promise": "always" }, "statements": { "promise": "always" }, "check_images": { "promise": "always" } }, "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" } ] } } }, "_debug": { "source_used": "<string>" }, "updated_at": "2023-11-07T05:31:56Z", "requires_desktop_app": true}
{
"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"
}
]
}
}
{
"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
connection_id
string
required
Canonical Connection id of the form con_<SOURCE>_<bankAccountId>
(e.g. con_FINICITY_41294, con_MX_1224, con_FDE_5009). Only
the canonical shape is accepted here. The placeholder UUID id
returned by POST /v3/clients/{id}/connections
(con_<uuid>, e.g. con_a1b2c3d4-e5f6-47a8-9b12-c3d4e5f6a7b8) is not
a valid value — calls with it return 400 with
missing source separator. See the lifecycle prose at the top
of this document for the full id-format contract.
Example:
"con_FINICITY_41294"
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 Connection.
id
string
required
Connection identifier. Two shapes can appear depending on
lifecycle state:
con_<uuid> — placeholder id surfaced during the
connection_with_action result while the connection is
pending. Used only to route the widget step. Calling
GET /v3/connections/{placeholder_uuid} returns 400 with
missing source separator.
con_<SOURCE>_<bankAccountId> — canonical id once the
connection reaches active. Every other endpoint
(/accounts, /transactions, /statements, refresh,
delete) expects this form.
See the lifecycle prose at the top of this document.
Example:
"con_FINICITY_41294"
client_id
string
required
Example:
"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0"
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
status
enum<string>
required
Connection lifecycle status.
initiated: Connection started, waiting for end-user or upstream to complete
requires_action: The end user has to act: answer MFA, re-enter credentials or reauthorize. last_error says which. When last_error.is_user_actionable is false (the institution locked the account) the action is at the bank itself, not in the widget
active: Healthy, refreshing on schedule
failed: The source or institution failed in a way the end user cannot fix; review last_error
disconnected: The connection no longer refreshes: the source stopped aggregating it (reconnect through reauthorization), LedgerSync could not refresh it, or it was deleted
Available options:
initiated,
requires_action,
active,
failed,
disconnected
created_at
string<date-time>
required
institution
object | null
Show child attributes
last_refreshed_at
string<date-time> | null
last_error
object | null
The inner error payload. Used as the top-level body of an
HTTP error response (wrapped in ErrorEnvelope) and as the
embedded error field on resources that record a failure
(like Operation.error).
Show child attributes
expected_capabilities
object | null
Catalog-derived promise for each capability we may deliver
on this connection. Plaid-style 4-tier:
always/usually/sometimes/never. Set when the
connection enters active and refreshed when the underlying
catalog row changes. Phase 1 emits only always/never
(per-FI tiering uses a profile catalog scheduled for Phase 2).
Show child attributes
realized_capabilities
object | null
Observed outcome of the most recent attempt at each
capability. Rolled-up across the connection's accounts —
worst-status-wins per capability. See
RealizedCapabilities for the per-capability shape.
Show child attributes
_debug
object
Observable-only debug metadata. Do not parse, do not branch
routing on these values. Fields under _debug may be removed,
renamed, or hashed at any time. Use the documented
realized_capabilities and last_error blocks for capability
and failure data.
Show child attributes
updated_at
string<date-time>
requires_desktop_app
boolean
FDE connections only; omitted for other sources. true when
this bank refreshes only through the LedgerSync desktop app,
which must be open and connected on the firm's computer for a
refresh to run.
{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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/connections/get-a-connection","slug":"/api-reference/connections/get-a-connection","pageMetadata":{"title":"Get a connection","description":"Look up a Connection by id. The `status` field tells you\nwhere it is in its lifecycle and `last_error` carries any\nrecent failure details.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /connections/{connection_id}","href":"/api-reference/connections/get-a-connection","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Look up a Connection by id. The \", _jsx(_components.code, {\n children: \"status\"\n }), \" field tells you\\nwhere it is in its lifecycle and \", _jsx(_components.code, {\n children: \"last_error\"\n }), \" carries any\\nrecent failure details.\"]\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 a connection","description":"Look up a Connection by id. The `status` field tells you\nwhere it is in its lifecycle and `last_error` carries any\nrecent failure details.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /connections/{connection_id}","href":"/api-reference/connections/get-a-connection","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ledgersync/6ae4be936c1d0f9f/ai-connector.js"],"openApiReferenceData":{"operation":{"tags":["Connections"],"operationId":"getConnection","summary":"Get a connection","description":"Look up a Connection by id. The `status` field tells you\nwhere it is in its lifecycle and `last_error` carries any\nrecent failure details.\n","parameters":["5902472d-0127-45e3-94fb-a1ee100fc49d"],"responses":{"200":"8f3990a1-0d73-48a3-8df1-224899445461","400":"2ba4419d-9ac5-4507-87f8-2077ae6030e8","401":"fe19aa26-a9e4-447d-ba07-f7a3f2b124aa","404":"4e54aef6-0830-47f1-a13f-8304021c6dae"},"method":"get","type":"path","servers":["c05434f0-e6f8-417e-89ec-e0c466a58105","1a9bd51d-9aae-48d2-815d-8a7938a9d6a7"],"security":["d8318703-d081-463f-981f-0ec94b99ab84"],"path":"/connections/{connection_id}","baseUrlOptions":["https://api-sandbox.ledgersyncappv2.com/v3","https://api.ledgersyncappv2.com/v3"],"title":"Get a connection","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5902472d-0127-45e3-94fb-a1ee100fc49d":{"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"}},"6371fda2-708e-49fe-9d6c-bc722fe856b6":{"in":"path","name":"connection_id","required":true,"description":"Canonical Connection id of the form `con_\u003cSOURCE>_\u003cbankAccountId>`\n(e.g. `con_FINICITY_41294`, `con_MX_1224`, `con_FDE_5009`). Only\nthe canonical shape is accepted here. The placeholder UUID id\nreturned by `POST /v3/clients/{id}/connections`\n(`con_\u003cuuid>`, e.g. `con_a1b2c3d4-e5f6-47a8-9b12-c3d4e5f6a7b8`) is **not**\na valid value — calls with it return 400 with\n`missing source separator`. See the lifecycle prose at the top\nof this document for the full id-format contract.\n","schema":{"type":"string","example":"con_FINICITY_41294","isRequired":true,"description":"Canonical Connection id of the form `con_\u003cSOURCE>_\u003cbankAccountId>`\n(e.g. `con_FINICITY_41294`, `con_MX_1224`, `con_FDE_5009`). Only\nthe canonical shape is accepted here. The placeholder UUID id\nreturned by `POST /v3/clients/{id}/connections`\n(`con_\u003cuuid>`, e.g. `con_a1b2c3d4-e5f6-47a8-9b12-c3d4e5f6a7b8`) is **not**\na valid value — calls with it return 400 with\n`missing source separator`. See the lifecycle prose at the top\nof this document for the full id-format contract.\n","uniqueKey":"","typeLabel":"string"}}},"responses":{"8f3990a1-0d73-48a3-8df1-224899445461":{"description":"The Connection.","content":{"application/json":{"schema":{"type":"object","required":["id","client_id","source","status","created_at"],"properties":{"id":{"type":"string","description":"Connection identifier. Two shapes can appear depending on\nlifecycle state:\n\n- `con_\u003cuuid>` — placeholder id surfaced during the\n `connection_with_action` result while the connection is\n `pending`. Used only to route the widget step. Calling\n `GET /v3/connections/{placeholder_uuid}` returns 400 with\n `missing source separator`.\n- `con_\u003cSOURCE>_\u003cbankAccountId>` — canonical id once the\n connection reaches `active`. Every other endpoint\n (`/accounts`, `/transactions`, `/statements`, refresh,\n delete) expects this form.\n\nSee the lifecycle prose at the top of this document.\n","example":"con_FINICITY_41294","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"client_id":{"type":"string","example":"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0","isRequired":true,"uniqueKey":"client_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>"},"status":{"type":"string","description":"Connection lifecycle status.\n\n- `initiated`: Connection started, waiting for end-user or upstream to complete\n- `requires_action`: The end user has to act: answer MFA, re-enter credentials or reauthorize. `last_error` says which. When `last_error.is_user_actionable` is false (the institution locked the account) the action is at the bank itself, not in the widget\n- `active`: Healthy, refreshing on schedule\n- `failed`: The source or institution failed in a way the end user cannot fix; review `last_error`\n- `disconnected`: The connection no longer refreshes: the source stopped aggregating it (reconnect through reauthorization), LedgerSync could not refresh it, or it was deleted\n","enum":["initiated","requires_action","active","failed","disconnected"],"x-enum-descriptions":["Connection started, waiting for end-user or upstream to complete","The end user has to act (MFA, credentials or reauthorization); see last_error","Healthy, refreshing on schedule","Failed in a way the end user cannot fix; review last_error","No longer refreshing (stopped by the source, not refreshable, or deleted)"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"institution":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","uniqueKey":"institution.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","example":"Chase","uniqueKey":"institution.oneOf.0.name","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"institution.oneOf.0.logo_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"institution.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"institution.oneOf.0.logo_url","typeLabel":"string\u003curi> | null"}},"uniqueKey":"institution.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"name":{"type":"string","example":"Chase"},"logo_url":{"oneOf":[{"type":"string","format":"uri"},{"type":"null","format":"uri"}]}},"uniqueKey":"institution.oneOf.1","typeLabel":"null"}],"uniqueKey":"institution","typeLabel":"object | 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"},"last_error":{"oneOf":[{"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":"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":"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":"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":"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":"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":"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":"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":"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":"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":"last_error.oneOf.0.errors.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","example":"must be a valid email address","isRequired":true,"uniqueKey":"last_error.oneOf.0.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","example":"invalid_email","uniqueKey":"last_error.oneOf.0.errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"last_error.oneOf.0.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"last_error.oneOf.0.errors","typeLabel":"object[]"}},"uniqueKey":"last_error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_error","typeLabel":"object | null"},"expected_capabilities":{"oneOf":[{"type":"object","description":"Catalog-derived promise for each capability we may deliver\non this connection. Plaid-style 4-tier:\n`always`/`usually`/`sometimes`/`never`. Set when the\nconnection enters `active` and refreshed when the underlying\ncatalog row changes. Phase 1 emits only `always`/`never`\n(per-FI tiering uses a profile catalog scheduled for Phase 2).\n","required":["transactions","balance","available_balance","statements","check_images"],"properties":{"transactions":{"type":"object","required":["promise"],"properties":{"promise":{"type":"string","description":"Plaid-style 4-tier promise tier for a single capability.\n`always` — source guarantees delivery (e.g. Finicity\ntransactions on a known-good FI). `usually` — supported,\nhistorical success rate is high. `sometimes` — supported but\nreliability is variable or unknown. `never` — source\nstructurally cannot deliver this capability.\n","enum":["always","usually","sometimes","never"],"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.transactions.promise","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.transactions","typeLabel":"object"},"balance":{"type":"object","required":["promise"],"properties":{"promise":{"type":"string","description":"Plaid-style 4-tier promise tier for a single capability.\n`always` — source guarantees delivery (e.g. Finicity\ntransactions on a known-good FI). `usually` — supported,\nhistorical success rate is high. `sometimes` — supported but\nreliability is variable or unknown. `never` — source\nstructurally cannot deliver this capability.\n","enum":["always","usually","sometimes","never"],"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.balance.promise","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.balance","typeLabel":"object"},"available_balance":{"type":"object","required":["promise"],"properties":{"promise":{"type":"string","description":"Plaid-style 4-tier promise tier for a single capability.\n`always` — source guarantees delivery (e.g. Finicity\ntransactions on a known-good FI). `usually` — supported,\nhistorical success rate is high. `sometimes` — supported but\nreliability is variable or unknown. `never` — source\nstructurally cannot deliver this capability.\n","enum":["always","usually","sometimes","never"],"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.available_balance.promise","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.available_balance","typeLabel":"object"},"statements":{"type":"object","required":["promise"],"properties":{"promise":{"type":"string","description":"Plaid-style 4-tier promise tier for a single capability.\n`always` — source guarantees delivery (e.g. Finicity\ntransactions on a known-good FI). `usually` — supported,\nhistorical success rate is high. `sometimes` — supported but\nreliability is variable or unknown. `never` — source\nstructurally cannot deliver this capability.\n","enum":["always","usually","sometimes","never"],"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.statements.promise","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.statements","typeLabel":"object"},"check_images":{"type":"object","required":["promise"],"properties":{"promise":{"type":"string","description":"Plaid-style 4-tier promise tier for a single capability.\n`always` — source guarantees delivery (e.g. Finicity\ntransactions on a known-good FI). `usually` — supported,\nhistorical success rate is high. `sometimes` — supported but\nreliability is variable or unknown. `never` — source\nstructurally cannot deliver this capability.\n","enum":["always","usually","sometimes","never"],"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.check_images.promise","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"expected_capabilities.oneOf.0.check_images","typeLabel":"object"}},"uniqueKey":"expected_capabilities.oneOf.0","typeLabel":"object"},{"type":"null","description":"Catalog-derived promise for each capability we may deliver\non this connection. Plaid-style 4-tier:\n`always`/`usually`/`sometimes`/`never`. Set when the\nconnection enters `active` and refreshed when the underlying\ncatalog row changes. Phase 1 emits only `always`/`never`\n(per-FI tiering uses a profile catalog scheduled for Phase 2).\n","uniqueKey":"expected_capabilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"expected_capabilities","typeLabel":"object | null"},"realized_capabilities":{"oneOf":[{"type":"object","description":"Observed outcome of the most recent attempt at each\ncapability. Rolled-up across the connection's accounts —\nworst-status-wins per capability. See\n`RealizedCapabilities` for the per-capability shape.\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":"Observed outcome of the most recent attempt at each\ncapability. Rolled-up across the connection's accounts —\nworst-status-wins per capability. See\n`RealizedCapabilities` for the per-capability shape.\n","uniqueKey":"realized_capabilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"realized_capabilities","typeLabel":"object | null"},"_debug":{"type":"object","x-stability":"experimental","description":"Observable-only debug metadata. **Do not parse, do not branch\nrouting on these values.** Fields under `_debug` may be removed,\nrenamed, or hashed at any time. Use the documented\n`realized_capabilities` and `last_error` blocks for capability\nand failure data.\n","properties":{"source_used":{"oneOf":[{"type":"string","description":"Internal source identifier that handled this connection.\nFor troubleshooting only — integrators should treat this as\nopaque. Example values: `FINICITY`, `MX`, `FDE`.\n","uniqueKey":"_debug.source_used.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal source identifier that handled this connection.\nFor troubleshooting only — integrators should treat this as\nopaque. Example values: `FINICITY`, `MX`, `FDE`.\n","uniqueKey":"_debug.source_used.oneOf.1","typeLabel":"null"}],"uniqueKey":"_debug.source_used","typeLabel":"string | null"}},"uniqueKey":"_debug","typeLabel":"object"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"requires_desktop_app":{"type":"boolean","description":"FDE connections only; omitted for other sources. `true` when\nthis bank refreshes only through the LedgerSync desktop app,\nwhich must be open and connected on the firm's computer for a\nrefresh to run.\n","uniqueKey":"requires_desktop_app","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"con_FINICITY_41294","client_id":"cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0","source":"FINICITY","status":"initiated","created_at":"2023-11-07T05:31:56Z","institution":{"id":"\u003cstring>","name":"Chase","logo_url":"\u003cstring>"},"last_refreshed_at":"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"}]},"expected_capabilities":{"transactions":{"promise":"always"},"balance":{"promise":"always"},"available_balance":{"promise":"always"},"statements":{"promise":"always"},"check_images":{"promise":"always"}},"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"}]}}},"_debug":{"source_used":"\u003cstring>"},"updated_at":"2023-11-07T05:31:56Z","requires_desktop_app":true}}},"exampleType":"generated"}},"exampleType":"generated"},"2ba4419d-9ac5-4507-87f8-2077ae6030e8":{"description":"Something in the request body or query string didn't pass\nvalidation.\n\nWhenever the failure is about one field, `error.param` names\nit, under `error.code = validation_failed` and\n`error.code = invalid_request` alike, as a dot-separated path\nfor nested fields (`line.amount`, `items[1].amount`). The same\nname is repeated inside `error.message` in the form\n`Field 'cursor': ...`, so either is usable, but `error.param`\nis the one to branch on.\n\nSchema validation additionally fills `error.errors[]` when\nseveral fields fail at once.\n\n`error.param` is absent when no single field is to blame: an\nerror that isn't about a field (auth, not found, upstream\nfaults), or a body that could not be parsed at all. In that\nlast case a few endpoints that parse the body themselves\nreport the literal `body` rather than omitting `param`;\neither way there is no field to highlight.\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"},"fe19aa26-a9e4-447d-ba07-f7a3f2b124aa":{"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"},"4e54aef6-0830-47f1-a13f-8304021c6dae":{"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 a connection - LedgerSync","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T23:35:19.627Z","originalFileLocation":"api-reference/connections/get-a-connection.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 Connection by id. The status field tells you where it is in its lifecycle and last_error carries any recent failure details.\">\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 a connection - LedgerSync\">\u003cmeta data-mint-head property=\"og:description\" content=\"Look up a Connection by id. The status field tells you where it is in its lifecycle and last_error carries any recent failure details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LedgerSync\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection\">\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=Connections\u0026amp;title=Get+a+connection\u0026amp;description=Look+up+a+Connection+by+id.+The+%60status%60+field+tells+you%0Awhere+it+is+in+its+lifecycle+and+%60last_error%60+carries+any%0Arecent+failure+details.%0A\u0026amp;theme=bcd469bc79d7c9d0510611ec\u0026amp;signature=371f52e484efc3c7fa01945f165a4c67b0245b49599a48def105290d3e2fad1b\">\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 a connection - LedgerSync\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Look up a Connection by id. The status field tells you where it is in its lifecycle and last_error carries any recent failure details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ledgersync.mintlify.site/_mintlify/api/og/v2?division=Connections\u0026amp;title=Get+a+connection\u0026amp;description=Look+up+a+Connection+by+id.+The+%60status%60+field+tells+you%0Awhere+it+is+in+its+lifecycle+and+%60last_error%60+carries+any%0Arecent+failure+details.%0A\u0026amp;theme=bcd469bc79d7c9d0510611ec\u0026amp;signature=371f52e484efc3c7fa01945f165a4c67b0245b49599a48def105290d3e2fad1b\">\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/connections/get-a-connection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/connections/get-a-connection.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/connections/get-a-connection#webpage\",\"url\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection\",\"name\":\"Get a connection\",\"description\":\"Look up a Connection by id. The status field tells you where it is in its lifecycle and last_error carries any recent failure details.\",\"dateModified\":\"2026-11-20T23:35:19.627Z\",\"isPartOf\":{\"@id\":\"https://docs.ledgersyncappv2.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Connections\",\"item\":\"https://docs.ledgersyncappv2.com/api-reference/connections/list-a-clients-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a connection\",\"item\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection#apireference\",\"headline\":\"Get a connection\",\"name\":\"Get a connection\",\"description\":\"Look up a Connection by id. The status field tells you where it is in its lifecycle and last_error carries any recent failure details.\",\"url\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ledgersyncappv2.com/api-reference/connections/get-a-connection#webpage\"},\"dateModified\":\"2026-11-20T23:35:19.627Z\",\"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/connections/get-a-connection.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","description":"Kick off a connection between a Client and a bank. Send only\n`institution_id` (a v3 catalog id from `GET /v3/institutions`).\nLedgerSync's router picks the underlying source (Finicity vs\nMX) per its routing rules — integrators don't pick a source.\n\nThe response:\n\n- **Finicity / MX** — we hand back a widget URL. Open it in\n the user's browser (or your mobile webview) and they'll\n finish linking. For MX the URL points at a\n LedgerSync-hosted wrapper page\n (`GET /connections/mx-wrapper`) that embeds the MX widget\n and gives you the same `redirect_url` + `ls_token`\n completion hop as Finicity (verify it at\n `POST /connections/redirect-token/verify`).\n- **FDE** — we return a `widget_url` to a LedgerSync-hosted\n connect page where the end user enters their bank\n credentials and answers any security questions in-session.\n Raw credentials are never sent to the API.\n\nYou get `202 Accepted` and an `operation_id` right away. Poll\n`GET /operations/{operation_id}` until the widget URL is ready,\nthen open `result.connection.action.widget_url`. Operation\n`succeeded` means the URL was issued; the user still needs to\ncomplete the widget. Connection lifecycle webhooks report later\nstatus changes.\n\n### Add accounts to an existing Finicity connection\n\nCall this endpoint with the existing `client_id` and the bank's\nv3 catalog `institution_id`. When routed to Finicity, it opens\nFull Connect using that client's existing Finicity customer.\nIn the widget, use the option to add accounts under the existing\nbank and complete the bank's authorization and account selection.\n`POST /connections/{connection_id}/reauthorize` opens Finicity\nConnect Fix for repairs and does not guarantee account selection\non a healthy connection.\n\nIf Finicity returns the same institution login and account\nidentities, LedgerSync reuses the existing connection and account\nids and attaches newly shared accounts. A different provider login\ncan create a separate connection, so this is not an unconditional\nguarantee that all ids stay the same.\n\nSnapshot all pages of `GET /v3/accounts?client_id=...` before the\nsession, then re-list after completion and compare account ids.\nThere is no public `account.added` webhook, and adding accounts\nto an active connection does not guarantee another\n`connection.active` event. The widget completion redirect and\noperation success do not establish that the accounts are already\npersisted; allow time for the account list to update.\n\n**Note on `connection.id`.** For Finicity and MX the embedded\n`result.connection.id` is a UUID-shaped **placeholder**\n(`con_\u003cuuid>`) that cannot be used with any other endpoint.\nFor a first-time connection, the canonical id,\n`con_\u003cSOURCE>_\u003cbankAccountId>` such as `con_FINICITY_41294` or\n`con_MX_1224`, is assigned when the source callback creates the\nconnection. An account-addition session can reuse an already\nassigned canonical id. This operation reaches `succeeded` as soon\nas the widget URL is issued, and its stored `result` is never\nrewritten, so a placeholder here stays a placeholder. Check\nthe shape before storing an id, and read the canonical one\nfrom the `connection.active` webhook or from\n`GET /clients/{client_id}/connections`. See the\n**Connection lifecycle** section at the top of this reference\nfor the full handshake.\n","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","description":"Revokes our access to the user's bank for this connection and\nremoves the Connection record. Accounts and transactions are\nkept for your historical reference unless you delete the\nwhole Client.\n\nOnce the delete succeeds, a `connection.disconnected` webhook\nis sent for the connection. It carries `client_id` whenever\nLedgerSync could read the connection's owner just before the\ndelete. Repeating the call afterwards returns 404 and sends\nnothing.\n","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","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","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 a connection - 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"]}