---
title: "Resolve a filing's per-disclosure HTML URL"
method: GET
path: "/api/v1/filings/{filing_id}/disclosure-url"
tags: ["Filings"]
---

# Resolve a filing's per-disclosure HTML URL

`GET /api/v1/filings/{filing_id}/disclosure-url`

## Request

- Base URL: `https://api.hub-equity.com`
- URL: `https://api.hub-equity.com/api/v1/filings/{filing_id}/disclosure-url`
- Auth: HTTP bearer

Returns the absolute URL of the SEC-rendered ``R{n}.htm`` page that displays the requested ``link_role`` (XBRL extended link role). Use it to link to the exact disclosure table; the mapping is read from the filing's ``FilingSummary.xml``. Falls back to the filing's iXBRL viewer when the summary is unreachable or the role is not exposed (ESEF filings, ancient filings, custom roles).

## Path parameters

- `filing_id` string, required

## Query parameters

- `link_role` string, required: XBRL link_role URI to resolve

## Response `200`

Successful Response

- ApiResponseDisclosureUrlPayload
  - `success` boolean, required
  - `data` DisclosureUrlPayload: Payload returned by ``GET /filings/{id}/disclosure-url``.
    - `filing_id` string, required
    - `link_role` string, required
    - `disclosure_url` string, required: Absolute URL to the per-disclosure HTML page (R{n}.htm) when the link_role can be matched in FilingSummary.xml; otherwise the filing's full iXBRL viewer URL as a fallback.
    - `fallback_to_viewer` boolean, required: True when the disclosure URL is the filing's viewer rather than a specific R{n}.htm page (ESEF filings, missing summary, or unmatched link_role).
  - `error` ApiError: API error details.
    - `code` string, required
    - `message` string, required
    - `details` object, nullable
  - `meta` ApiMeta: API response metadata. Pagination fields (``page`` / ``per_page`` / ``total``) are populated on collection endpoints only. They are omitted from the payload on single-resource endpoints.
    - `timestamp` string, date-time
    - `request_id` string, nullable
    - `page` integer, nullable
    - `per_page` integer, nullable
    - `total` integer, nullable
  - `links` ApiLinks: HATEOAS-style pagination cursors. Host-relative path + query links for a collection page. Present on collection endpoints, ``null`` fields where a page doesn't exist (``next`` on the last page, ``prev`` on the first). The whole ``links`` object is omitted from single-resource responses (see ``ApiResponse`` serializer).
    - `self` string, nullable
    - `first` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
    - `last` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/hub-equity/apis/hub-equity-api.md) · [All operations](https://skmtc.dev/hub-equity/apis/hub-equity-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hub-equity/apis/hub-equity-api/revisions/e8eeda5dc13e?raw)
