2026-08-13

Summary: Agreements Now Expose Product Metadata and Support Filtering

Documents

New Fields on AgreementResponse

GET /agreements now returns

additional metadata for each agreement:

  • scope - whether the agreement applies platform-wide (platform) or is tied to a specific product (product).
  • product - the product the agreement is tied to (e.g. brokerage or retirement_account), or null for
    platform-wide agreements.
  • acceptance - whether the customer must actively accept the agreement (required) or it is informational
    (not_required).
  • effective_at - the point in time from which the document version is effective.

New Query Filters

GET /agreements now accepts

optional filters:

  • scope=platform returns only platform-wide agreements; scope=product (together with product) returns only the
    agreements tied to that product.
  • product narrows results to a single product and is only valid together with scope=product.
  • acceptance=required / acceptance=not_required filters by whether active acceptance is needed.

Invalid combinations return a 400 response, for example product without scope=product, or scope=platform
together with a product.