Skip to main content
GET
/
disclosures
/
{disclosure_id}
Get a single disclosure
curl --request GET \
  --url https://api.bluumfinance.com/v1/disclosures/{disclosure_id}
{
  "object": "disclosure",
  "id": "hyc_non_shariah_new_customer_ack",
  "version": "2026-05-23",
  "title": "<string>",
  "requires_acknowledgement": true,
  "text": "<string>",
  "url": "<string>",
  "links": [
    {
      "text": "<string>",
      "url": "<string>"
    }
  ],
  "source_reference": "<string>"
}

Path Parameters

​
disclosure_id
string
required

The disclosure's stable id (e.g. hyc_non_shariah_new_customer_ack, investor_agreement_ack, alpaca_library_form_crs).

Response

Disclosure resource.

​
object
enum<string>
required
Available options:
disclosure
​
id
string
required

Stable identifier referenced when recording an acceptance.

Example:

"hyc_non_shariah_new_customer_ack"

​
version
string
required

Revision tag. Partners detect copy changes by comparing this against the version they last presented to the user.

Example:

"2026-05-23"

​
source
enum<string>
required

Whether the disclosure originates from Alpaca or from Bluum.

Available options:
alpaca,
bluum
​
kind
enum<string>
required

verbatim_text — text holds copy the partner must render word-for-word. pdf_link — url points to the canonical PDF. html — url points to an HTML page.

Available options:
verbatim_text,
pdf_link,
html
​
route
enum<string>
required

Onboarding route this disclosure applies to.

Available options:
all,
us,
international
​
step
enum<string>
required

The point in the partner UI where this disclosure must be surfaced. step_hyc_enrollment is the FDIC Sweep program enrollment screen. step_fixed_income_enrollment is the bond / treasury risk disclosure shown before a partner allows the user's first fixed-income order.

Available options:
step_6_affiliations,
step_7_w8_certification,
step_9_broker_agreements,
step_12_post_account,
step_hyc_enrollment,
step_fixed_income_enrollment,
platform_signup
​
title
string
required

Human-readable title for partner UIs (not regulated copy).

​
requires_acknowledgement
boolean
required

true if the partner must capture an explicit click ("Accept", "Enroll", or "I Agree") and record it via POST /v1/investors/{investor_id}/disclosures/acceptances or via the signed_agreements[] array on account creation.

​
text
string | null

Markdown. Verbatim regulated text the partner must display unchanged. Present only when kind=verbatim_text. Translations are permitted only if they match the plain-text rendering word-for-word.

References to named documents (e.g. Alpaca Customer Agreement, FDIC Bank Sweep T&Cs) are embedded inline using standard markdown link syntax [text](url) so partners can pass the body through any markdown renderer and get clickable links with no extra wiring. The structured links array below mirrors the same data for partners that prefer to skip markdown — both are kept in lockstep.

Plain-text fallback: if you don't render markdown, strip the [](url) syntax (keep the bracket contents) to recover Alpaca's word-for-word regulated copy.

​
url
string<uri> | null

Canonical URL for pdf_link / html disclosures, or the underlying PDF for verbatim_text disclosures that also have a printable form.

​
links
object[]

References named in the body of a verbatim_text disclosure that the partner must surface as clickable links from the enrollment screen. Each entry's text matches a substring of text verbatim — partners do a literal find-and-replace to wrap the substring in an anchor tag.

For example, the HYC enrollment acknowledgement names both "Alpaca Customer Agreement" and "Alpaca Securities LLC Bank Sweep Program Terms and Conditions"; both must be reachable from the screen per Tech Sign Off HYC 2.0.

Absent on pdf_link / html disclosures (the single url covers those).

​
agreement_key
enum<string> | null

When this disclosure corresponds to an entry in the signed_agreements[] array on POST /v1/investors, this field holds the matching key. Use it to wire the disclosure into the create-investor payload so the acknowledgement is captured at account-create time.

Null for Bluum-side-only disclosures and for HYC / fixed income acknowledgements — those are persisted via the acceptances endpoint instead.

Available options:
investor_agreement,
margin_disclosure_acknowledged,
w8ben_certification
​
source_reference
string

Internal reference (Alpaca spreadsheet row or Bluum doc) — useful for audit.