Skip to main content
GET
Get one institution by v3 catalog id

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

id
string
required

Response

The institution.

A row in the unified v3 institution catalog. Returned by GET /v3/institutions and used as institution_id when initiating a connection.

id
string
required
Example:

"ins_01HZX9CHASE"

name
string
required
capabilities
object
required

Capability flags advertised by the catalog. Computed as the union across the underlying sources LedgerSync would route to for this institution. null on any flag means "unknown / not yet reconciled" — the router will still attempt to dispatch.

home_url
string<uri> | null
requires_desktop_app
boolean

true when LedgerSync reaches this bank through FDE and refreshes it only through the LedgerSync desktop app, which must be open and connected on the firm's computer. Omitted when unknown.