Retrieve Data

Get processed transaction and portfolio data from an uploaded file.

The response structure in the data field varies by statement_type:

Statement TypeData Structure
brokeragedata.ownerships[] — array of holdings with ticker, value, cost basis, asset class, etc.
tax_formsdata.forms[] — array of tax form extractions with form type and reviewed data
trustdata.extracted_data — trust document fields (grantors, trustees, distribution, etc.)
balance_sheetdata.ownerships[] — array of $cash holdings, one per balance sheet line item (account name, value, account type)

Bounding Box Citations

When enable_bbox_citations is enabled for your firm and include_bbox=true is passed as a query parameter, each ownership includes a bounding_boxes field containing PDF coordinates for audited fields.

Response values:

  • null — Feature not enabled for your firm
  • {} — Feature enabled, but no citation data available for this holding
  • {field: {page, x1, y1, x2, y2}} — Citation coordinates for each audited field

Coordinate system: Values are percentages (0–100) of page dimensions. Format is XYXY — x1,y1 is the top-left corner and x2,y2 is the bottom-right corner.

Available fields in bounding_boxes:

FieldDescription
statement_asset_valueMarket value
quantityShare/unit quantity
statement_pricePrice per share/unit
statement_cost_basisCost basis
statement_gain_lossUnrealized gain/loss
nameHolding name
tickerTicker symbol

Only fields with citation data are included. Fields without bounding box data are omitted from the object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

File upload ID

Query Params
string
enum
Defaults to false

Set to "true" or "1" to include per-field bounding box citations in the ownership response. Requires enable_bbox_citations to be enabled for your firm.

Allowed:
Responses

400

Bad request — file not found or access denied

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json