Record a disclosure acceptance
Records an end-user’s explicit acceptance of a disclosure (the
“checkbox click”). Used when the partner is recording the
acknowledgement out-of-band from POST /v1/investors —
for example, when the user accepts a disclosure in-app after
their account was already created, or when re-prompting after
a version bump.
For Alpaca-required acknowledgements that map to an Alpaca
agreement key (customer_agreement, w8ben_certification),
prefer submitting via the signed_agreements[] array on
POST /v1/investors so Alpaca receives the acceptance at
account-create time. Use this endpoint for post-hoc acceptances
or Bluum-only disclosures.
Authorizations
HTTP Basic Authentication using the API Key as username and API Secret as password.
Path Parameters
Prefixed public investor id (inv_…).
Body
Stable id from the disclosure registry.
"hyc_non_shariah_new_customer_ack"
Version the user is acknowledging. If omitted the server stamps the current version from the registry.
"2026-05-23"
ISO-8601 timestamp of the click. Defaults to server time.
Client IP that performed the click. Defaults to request IP.
Client user-agent string. Defaults to the request User-Agent header.
Partner-defined reference for the acting user (e.g. session id, dashboard user id).