v1

latestOpenAPI 3.0.02026-07-245018.3 KB
/file_uploads/{id}/data

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.

get/api/v1.0/public/file_uploads/{id}/data

Path parameters

idinteger required

File upload ID

Query parameters

include_bbox'true' | '1' | 'false' | '0'

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.

Response

Processed data retrieved

idinteger

File upload ID

statusstring

File processing status

statement_typestring

Type of statement processed

dataobject

Processed data payload — structure varies by statement_type (see endpoint description)

countinteger

Number of items returned

pageinteger

Current page number (for paginated responses)