Get an account

curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "acc_FINICITY_45",
  "source": "FINICITY",
  "iso_currency_code": "USD",
  "connection_id": "con_FINICITY_41294",
  "client_id": "<string>",
  "name": "<string>",
  "type": "checking",
  "mask": "1234",
  "current_balance": 1234.56,
  "available_balance": 123,
  "last_refreshed_at": "2023-11-07T05:31:56Z",
  "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"
          }
        ]
      }
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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"
      }
    ]
  }
}

GET

accounts

{account_id}

Get an account

curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.ledgersyncappv2.com/v3/accounts/{account_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "acc_FINICITY_45",
  "source": "FINICITY",
  "iso_currency_code": "USD",
  "connection_id": "con_FINICITY_41294",
  "client_id": "<string>",
  "name": "<string>",
  "type": "checking",
  "mask": "1234",
  "current_balance": 1234.56,
  "available_balance": 123,
  "last_refreshed_at": "2023-11-07T05:31:56Z",
  "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"
          }
        ]
      }
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "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

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.

string

required

Example:

"acc_FINICITY_45"

source

enum<string>

required

Financial-data source backing an account. Aggregator sources (FINICITY, MX) and FDE back a Connection; PDF does not.

Values:

FINICITY — Finicity aggregation
MX — MX aggregation
FDE — Financial Document Extraction (LedgerSync proprietary)
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

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.

Show child attributes

created_at

string<date-time> | null

When LedgerSync first stored this account, which is when we first saw it at the source. For accounts present at link time this tracks the connection; for one shared later it is when it arrived. There is no account.added webhook, so this is the field to sort or diff on when you re-list accounts to find what is new. It never moves afterwards.

updated_at

string<date-time> | null

Health

Clients

Connections

Settings

Institutions

Accounts

Transactions

Statements

Checks

Operations

Webhooks

ApiKeys

Sandbox

Metrics

PortalGating

Get an account

Authorizations

Path Parameters

Query Parameters

Response