Entities

XBRL accounting / calculation linkbase checks across an entity's filings

Entity-scoped variant of /filings/{id}/validation-results: surfaces the accounting and calculation checks run on the entity's filings (optionally one fiscal year). accounting_equation / calculation / hub_calculation checks.

Default status_filter = ['warning','error']. Sorted by severity then |relative_difference|, capped at 100 rows.

get/api/v1/entities/{entity_id}/validation-results

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/entities/{entity_id}/validation-results
  • Auth: HTTP bearer

Path parameters

entity_idstring required

Query parameters

fiscal_yearinteger nullable

Restrict to one fiscal year.

status_filterstring[] nullable

Statuses to include. Default ['warning','error']. Repeat the param for multiple (e.g. ?status_filter=valid&status_filter=skipped).

Response

Validation checks for the entity.

successboolean required

Changes

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