Get a check
Returns one check’s metadata, including a download_url for its image.
Authorizations
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.
Query Parameters
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.
"chk_FDE_742778"
The owning account id.
"acc_FDE_77"
Financial-data source backing an account. Aggregator sources
(FINICITY, MX) and FDE back a Connection; PDF does not.
Values:
FINICITY— Finicity aggregationMX— MX aggregationFDE— Financial Document Extraction (LedgerSync proprietary)PDF— Uploaded bank statements. Read-only: exposed on/accountsand/transactions(statements are not served for PDF), and never as a Connection (PDF accounts haveconnection_id: null).
FINICITY, MX, FDE, PDF 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 as reported by the bank.
"1234"
Check amount as reported by the bank.
Payee as reported by the bank.
Free-text description carried on the check record.
Date of the bank transaction this check belongs to.
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.
