Documents

Get structured document data

Retrieve structured document data including accounts and transactions. Only available when document status is completed. Transactions are paginated. Rate limit: 60 requests per minute.

get/documents/{id}/data

Request

  • Base URL: https://api.bankstatemently.com/v1
  • URL: https://api.bankstatemently.com/v1/documents/{id}/data
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required

The document UUID.

Query parameters

rawboolean

Set to true to include originalData (raw pre-normalization cell values) on each transaction. When enabled, max limit is reduced to 500.

limitinteger

Maximum number of transactions per page.

offsetinteger

Number of transactions to skip for pagination.

Response

Structured document data. Primary shape: document.statements[].products[].accounts[].transactions[]. Legacy flat accounts[] and transactions[] retained for backward compatibility.

Changes

No recorded changes to this operation across all 1 revision of this API.