Error codes

Every error the LedgerSync API returns includes a stable error.code, a one-line error.message, and a error.doc_url linking to one of the pages below. Branch on code in your client — it's the stable contract.

• access_request_not_approved

  Access request not approved
  Authentication · 403
• account_locked_by_institution

  Account locked by the bank
  API error · 502
• agreement_required

  Bank agreement needs acceptance
  API error · 502
• billing_not_configured

  Billing not configured
  Authentication · 403
• credentials_invalid

  Bank credentials rejected
  API error · 502
• fde_unsupported

  Operation not supported by FDE
  API error · 502
• idempotency_conflict

  Idempotency key reused with different body
  Idempotency · 409
• institution_unavailable

  Institution is having issues
  API error · 502
• insufficient_scope

  API key missing required scope
  Authentication · 403
• internal_error

  Internal server error
  API error · 500
• invalid_request

  Invalid request
  Invalid request · 400
• invalid_signature

  Invalid request signature
  Authentication · 401
• invalid_timestamp

  Request timestamp out of range
  Authentication · 401
• method_not_allowed

  Method not allowed
  Invalid request · 405
• mfa_expired

  MFA challenge expired
  API error · 502
• mfa_required

  Multi-factor authentication required
  API error · 502
• missing_auth_headers

  Authentication headers missing
  Authentication · 401
• not_found

  Not found
  Not found · 404
• rate_limit_exceeded

  Rate limit exceeded
  Rate limit · 429
• reauthorization_required

  Reauthorization required
  API error · 502
• refresh_not_supported

  Refresh not supported for this connection
  API error · 502
• replayed_nonce

  Nonce already used
  Authentication · 401
• revoked_api_key

  API key revoked
  Authentication · 401
• source_internal_error

  Aggregator hit an internal error
  API error · 502
• source_rate_limited

  Bank source rate-limited the request
  API error · 502
• statement_extraction_failed

  Statement extraction failed
  Invalid request · 422
• statements_not_supported

  Statements not supported by source
  API error · 502
• unknown_api_key

  Unknown API key
  Authentication · 401
• upstream_unavailable

  Upstream unavailable
  API error · 502
• validation_failed

  Request validation failed
  Invalid request · 400
• version_conflict

  Row was updated by someone else
  Idempotency · 409