Skip to content
API · For Developers

Everything you need to build on Ledgersync.

A self-serve developer portal, sandbox and live environments, a v3 REST API, signed webhooks, and a quickstart that takes you from signup to your first webhook in 15 minutes.

Build it in 15 minutes

Set aside about 15 minutes. By the end you'll have a working bank connection in sandbox — transactions in your database and a webhook firing on every refresh.

What's actually in the product

A developer portal that does the work for you.

Developer Portal

Self-serve everything from https://portal.ledgersyncappv2.com.

  • Self-serve signup with an approval gate
  • Sandbox-or-Live environment switcher
  • Onboarding form — env-aware: short for sandbox, full KYC-style for live (with Zoho CC for billing)
  • Dashboard overview with an integration guide
  • API keys page: create, list, rotate, scope — separate sandbox and live keys
  • Webhooks page: subscribe a URL, choose event types, manage the signing secret, fire a test event
  • Testing playbook with sandbox bank credentials
  • API docs — Scalar viewer of the OpenAPI spec
  • Error codes reference

Metrics page

Four tiles plus four charts, all with custom date ranges.

  • Tiles: clients, accounts, webhook subscriptions, API keys
  • Charts: API requests, connection health, webhook deliveries, top institutions
  • Custom date-range selection on every chart
Authentication options

Sign in your way.

  • Email and password — 10 character minimum, complexity rules, breach rejection via HaveIBeenPwned, last-5 password reuse blocked
  • Magic Auth — 6-digit email code, passwordless
  • Google sign-in
API surface · v3 REST

Every resource you'd expect, and a few you wouldn't.

Clients

  • Full CRUD

Connections

  • Initiate, list, get, refresh, delete
  • Submit MFA form

Accounts

  • List, get

Transactions

  • List with filters

Statements

  • List, download PDF

Webhook subscriptions

  • Full CRUD
  • Rotate signing secret
  • Send test event

Institutions catalog

  • List, search

Operations

  • Poll status of async work

Metrics

  • Summary, time series, connection health, top institutions, API usage, webhook delivery

API keys

  • Full CRUD
  • Rotate

Health probe

  • Service health endpoint
Webhook events emitted

Signed events for every meaningful change.

connection.initiatedconnection.requires_actionconnection.activeconnection.failedconnection.disconnectedconnection.refreshedconnection.capability_changedtransaction.createdstatement.availableaccount.refresh.completedaccount.refresh.failedwebhook.test
Security

Scopes, signatures, and isolation by default.

  • 13 scopes — read/write/manage variants for clients, connections, accounts, transactions, statements, webhooks, api-keys, and metrics
  • HMAC-SHA256 webhook signatures with a Stripe-style timestamp prefix
  • Headers: X-LS-Webhook-Signature, X-LS-Webhook-Timestamp, X-LS-Webhook-Event-Id, X-LS-Webhook-Event-Type
  • 24-hour grace window after secret rotation — old and new signatures both valid
  • Cloudflare Turnstile on signups
  • Sandbox and live keys clearly prefixed (sk_test_ vs sk_live_)
  • Per-environment isolated WorkOS auth context
Developer experience

Built to be debugged.

  • Stripe-style two-level error envelope: error.code, error.type, error.category, doc_url, is_user_actionable, trace_id
  • Per-env Postman collection auto-served (sandbox vs live, host-aware), every request ships with pm.test assertions
  • Quickstart guide that walks from signup to first webhook in 15 minutes
  • Test bank credentials documented per source — FinBank Decertified for Finicity, mxbank for MX
  • OpenAPI 3 spec served from the portal

8 error categories

Every error carries a category so you can branch on it programmatically.

AUTH_ERRORINSTITUTION_ERRORCAPABILITY_UNAVAILABLECONNECTION_ERRORRATE_LIMITINVALID_REQUESTRESOURCE_NOT_FOUNDPLATFORM_ERROR
Sources covered

Aggregator coverage, active today.

Finicity

Test bank: FinBank Decertified

Active

MX

Test bank: mxbank

Active

Need the full reference? The developer portal serves the OpenAPI 3 spec, Scalar docs, and a per-environment Postman collection. Or head back to the API overview.

Ready to automate the data work?

Start your 30-day free trial. Credit card required at sign-up — you won't be charged until the trial ends, and you can cancel anytime.

30 days free · credit card required · cancel anytime