Skip to main content
GET
Get a check

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
check_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 Check.

One paper check captured from an account, with its image. FDE-only — no other source delivers check images. LedgerSync captures the front of a check only, so a check is exactly one image and there is no side field.

id
string
required
Example:

"chk_FDE_742778"

account_id
string
required

The owning account id.

Example:

"acc_FDE_77"

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
download_url
string<uri>
required

Relative v3 URL to download the check image, auth-scoped to your API key. Resolves to GET /accounts/{account_id}/checks/{check_id}/download.

check_number
string | null

Check number as reported by the bank.

Example:

"1234"

amount
number<double> | null

Check amount as reported by the bank.

pay_to
string | null

Payee as reported by the bank.

description
string | null

Free-text description carried on the check record.

transaction_date
string<date> | null

Date of the bank transaction this check belongs to.

ocr
object | null

What OCR read off the image, kept separate from the bank-reported fields above so you can always tell the two apart. Absent when nothing was recognised.