Skip to navigation

Retrieve a bank statement

Retrieves a single extracted bank statement, with account numbers masked. Requesting a document of any other type returns a 404.

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
The borrower's id.
doc_idstringRequired
The document's id.

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.

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
reportType"bank_statement_analysis"

Always bank_statement_analysis.

accountobject
The account the statement is for.
periodobject
The statement period with its opening and closing balances.
metricsobject
Totals over the statement period.
dailyBalanceslist of objects
One entry per day of the period.
transactionslist of objects
Every transaction, in statement order.
period_sourcestringOptional

Whether the statement prints both ends of its period (declared) or at least one end is a date stated elsewhere in the statement’s own text (statement_text); absent when the statement states no period.

balance_sourcestringOptional

Where the period balances come from when the statement prints none: the linked account’s current balance carried back through its own posted transactions, or the account’s daily balances when the feed carries them (feed_balance); absent when the statement prints its balances.

underwritingFlagslist of objectsOptional
Notes about fees, returned items and other events in the transactions, when 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