Skip to navigation

List all statement mappings

Lists a borrower’s statement mappings, one per document that has one, newest document first, each as the retrieve returns it. Pass loanId to narrow the list to one loan, and page with limit (1 to 25, default 10) and cursor. pending_document_ids names the documents whose first mapping is still being prepared; read again until it is empty. Requires a plan that includes statement mapping; other plans get a 403.

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

borrowerIdstringRequired
The borrower'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.

Query parameters

loanIdstringOptional
Narrow the list to one loan.
limitintegerOptional
Page size, 1 to 25. Defaults to 10.
cursorstringOptional

The next_cursor from the previous page.

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
datalist of objects

The page: one mapping per document, each as the mapping read returns it for that document, ordered by the document's creation time, newest first.

limitinteger

The page size applied: limit as given, 1 to 25, or 10 when none was.

pending_document_idslist of strings

The ids of the documents of the borrower, or of the loan when loanId is given, that have no mapping yet and whose first mapping is being prepared, newest document first. A statement nobody has asked for is prepared by the read that finds it. Empty when there are none.

next_cursorstring or nullOptional

An opaque string to pass as cursor for the next page. Null when there are no more mappings.

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