Check images are FDE-only — no other source delivers them. Finicity, MX and
PDF accounts have no checks, and asking for theirs returns an empty list rather
than an error (see Sources without checks).
There is no back image. LedgerSync captures the front of a check only, so
a check is exactly one image and there is no
side field to pass or branch on.Before you start
Your API key needs theread:checks scope. A key minted before check support
shipped won’t have it, and every check route will answer 403 insufficient_scope.
Tick the scope on a new key in the developer portal, or widen the key you
already have — the
calling key needs write:api-keys, and {id} is the key’s id from
GET /v3/api-keys (not the sk_test_... secret):
Add read:checks to an existing key
write:checks.
Keys created in the developer portal carry it from now on; add it to an older
key the same way, keeping every scope it already has:
Add write:checks to an existing key
List an account’s checks
Reads are Client-scoped, so passclient_id every time.
List checks
Response
chk_FDE_<id>, source-tagged like every other v3 id. Checks come
newest first: the check LedgerSync captured most recently is first. The list
paginates with limit and cursor exactly like the rest of the API — see
Pagination.
Download the image
download_url on each check is a ready-to-call relative URL — prefer it over
building the path yourself:
Download
Content-Type is determined by inspecting
the image’s own magic bytes (image/png, image/jpeg or image/gif;
application/octet-stream if the bytes match none of those), and
Content-Disposition names the file <check_id>.<ext> to match.
Bank-reported vs OCR fields
Every check carries two independent readings of the same piece of paper, and they are deliberately kept apart:
The two routinely disagree, and individual
ocr fields are often null where
recognition failed — as check_number is above. OCR is best-effort on a
photograph of handwriting; the bank’s own record is the authoritative one. Treat
ocr as a hint (for search, prefill, or reconciliation review), never as ground
truth for money movement. The whole ocr object is omitted when nothing at all
was recognised.
Correct a check
When OCR misread a check, fix it the same way a firm does in the LedgerSync app: send the corrected values insideocr. Only the ocr readings can be
corrected. The bank-reported fields stay exactly as the bank sent them.
Correct the payee and the amount
GET.
The fields you can send are
pay_to and memo (up to 500 characters each),
check_number (up to 100), bank_name (up to 255), amount (a number with at
most 2 decimal places and 13 digits before the decimal point) and check_date
(a date as YYYY-MM-DD). Leading and trailing spaces are removed from text.
The correction is saved in LedgerSync, so the firm sees it in the app too, with
the same effects as a correction made there: when the check has both an OCR
amount and an OCR check date, LedgerSync matches it again to its bank
transaction, and a corrected payee can also appear in the matched transaction’s
description. Later refreshes from the bank feed keep your correction: once any
reading of a check is corrected, all six of its ocr readings stay as they are
when the bank feed refreshes the check. A request that changes nothing leaves the
check untouched.
Sources without checks
Only FDE accounts can have check images, and the API distinguishes “this source has none” from “you asked wrong”:The non-FDE short-circuit is evaluated before ownership, so listing checks on a
non-FDE account you don’t own returns
200 with an empty array rather than
404. It carries no data either way.Try it in sandbox
The sandbox Ledgersync Bank (ins_a7397a8d0656e1b7) returns real check
images, so you can exercise all four routes end-to-end without a live bank:
1
Connect Ledgersync Bank
Follow FDE — Ledgersync Bank. It accepts any username and password.
2
Wait for connection.active
Extraction is asynchronous. Checks land once the connection completes — listen for the
connection.active webhook rather than polling immediately.3
Find the account, then its checks
GET /v3/accounts?client_id=...&connection_id=con_FDE_... gives you the acc_FDE_... id; pass it to the list route above.Full reference
Every parameter and response field for the four check routes.
