Skip to navigation
APIEquity Statements

Retrieve an equity statement

Retrieves a single extracted equity statement. 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-07-19. 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-07-19.

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
entitystring or null
The reporting entity's name as printed.
titlestring or null
The statement's printed title.
layoutenum

How the statement is laid out: matrix when the equity components run across as columns and the balances and movements run down as rows; vertical when the periods run across as columns.

Allowed values:
period_headerstring

The period wording printed over the statement, such as the years ended; empty when the statement prints none.

cpa_engagementinteger0-3

The accountant's level of assurance: 0 unaudited, 1 compiled, 2 reviewed, 3 audited.

cpa_engagement_labelstring
The assurance level in words.
periodslist of objects
The periods the statement covers, one entry per period.
billing_yearsinteger
Years of data billed for the statement.
reporting_unitenum
The unit the figures are printed in, such as ones or thousands.
Allowed values:
scale_multiplierinteger>=1

Scale of the printed figures: 1 for whole dollars, 1000 when the statement is stated in thousands, 1000000 when it is stated in millions.

unit_exceptionslist of strings

The carve-outs the statement's unit declaration lists, such as share data, which keep their printed figures; empty when it lists none.

unit_sourceenum

Where the statement states its unit: printed when the statement header, a column header or a heading line prints it; none when nothing is printed and the figures are whole dollars as printed.

Allowed values:
columnslist of objects
The statement's figure columns in print order.
total_columninteger or null

Position in columns, counting from zero, of the column that prints the total of the components; null when the statement has none.

rowslist of objects
The statement's rows in print order.
statusenum

RECONCILED when every row's components add to its printed total and every opening balance plus the period's movements equals the closing balance; FLAGGED otherwise.

Allowed values:
presentationenumOptional

How the statement is presented: formal when it is presented as issued financial statements; free_form when it is a report out of the books (accounting software or a spreadsheet).

Allowed values:
signalslist of objectsOptional
Each check of the statement that does not hold, in words, when any does not.
packetobjectOptional
Where the statement sat in the financial statement packet it arrived in, when it arrived in one.

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