Skip to navigation

List all bank statement accounts

Lists the bank accounts seen across the borrower’s extracted bank statements, one entry per statement in period order, carrying only the account’s identity and statement period. It’s the cheap way to learn which accounts and months are on file without pulling full statement payloads. Pass loan_id to narrow it to one loan. Duplicates and failed extractions are left out. When the borrower’s balance sheet names its bank accounts, a document_account_labels roster also maps each account’s last four digits to the name the balance sheet uses for it.

Requires the extractions:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

borrower_idstringRequired
Id of the borrower whose extractions are read. A borrower the caller cannot access is a 404.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Query parameters

loan_idstringOptional

Optional. Restricts the read to this loan’s documents; omit to read across all of the borrower’s loans. A loan the caller cannot access is a 404. An embed session is always held to its bound loan.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
borrower_idstringformat: "^[0-9a-f]{24}$"
The borrower the documents belong to.
statementslist of objects
One row per document.
document_account_labelslist of objectsOptional
Balance sheet account names for the accounts in this list, when a balance sheet on the file prints any.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error