Skip to main content
GET
/
accounts
/
{account_id}
Get an account
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "acc_FINICITY_45",
  "iso_currency_code": "USD",
  "connection_id": "con_FINICITY_41294",
  "client_id": "<string>",
  "name": "<string>",
  "mask": "1234",
  "current_balance": 1234.56,
  "available_balance": 123,
  "last_refreshed_at": "2023-11-07T05:31:56Z",
  "realized_capabilities": {
    "transactions": {
      "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": {
      "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": {
      "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": {
      "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": {
      "last_success_at": "2023-11-07T05:31:56Z",
      "next_refresh_after": "2023-11-07T05:31:56Z",
      "last_error": {
        "code": "unknown_api_key",
        "message": "The API key you presented doesn't match any active key.",
        "type": "auth_error",
        "doc_url": "https://portal.ledgersyncappv2.com/errors/unknown_api_key",
        "category": "AUTH_ERROR",
        "is_user_actionable": true,
        "source_diagnostic_code": "FIN-103",
        "param": "client.email",
        "trace_id": "4bf92f3577b34da6a3ce929d0e0e4736",
        "errors": [
          {
            "param": "client.email",
            "message": "must be a valid email address",
            "code": "invalid_email"
          }
        ]
      }
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Path Parameters

​
account_id
string
required

Query Parameters

​
client_id
string
required

The Client (cli_…) to scope the read to. Required on account, transaction, and statement reads — LedgerSync's backend data APIs are scoped per end-user, so these resources are resolved within a single Client.

Response

The Account.

​
id
string
required
Example:

"acc_FINICITY_45"

​
source
enum<string>
required

Financial-data source backing a connection. All sources wrap upstream aggregators or extraction pipelines.

Values:

  • FINICITY — Finicity aggregation
  • MX — MX aggregation
  • FDE — Financial Document Extraction (LedgerSync proprietary)
Available options:
FINICITY,
MX,
FDE
​
iso_currency_code
string
required

ISO-4217 currency code. Defaults to USD when the source omits it.

Example:

"USD"

​
connection_id
string | null

Owning connection — canonical id (con_<SOURCE>_<bankAccountId>). Null on a sandbox single-fetch (a sandbox account id doesn't encode its connection). Always present when listing accounts by connection.

Example:

"con_FINICITY_41294"

​
client_id
string
​
name
string
​
type
enum<string>
Available options:
checking,
savings,
credit_card,
loan,
investment,
other
​
mask
string | null

Last 4 digits of the account number (Plaid-style mask).

Example:

"1234"

​
current_balance
number | null

Most recent balance in the account's currency, as a decimal. Null when the source hasn't reported one yet.

Example:

1234.56

​
available_balance
number | null

Available balance, when the source distinguishes it from the current balance. Often null.

​
last_refreshed_at
string<date-time> | null
​
realized_capabilities
object | null

Per-account observed outcome of the most recent attempt at each capability. Today the backend tracks status at the bank level — accounts within the same connection share this snapshot. Per-account divergence (one account in a connection failed but others succeeded) requires a backend extension and is deferred.

​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null