2026-08-13
6 days ago by ReadMe API
Summary: Agreements Now Expose Product Metadata and Support Filtering
Documents
New Fields on AgreementResponse
AgreementResponseGET /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.brokerageorretirement_account), ornullfor
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=platformreturns only platform-wide agreements;scope=product(together withproduct) returns only the
agreements tied to that product.productnarrows results to a single product and is only valid together withscope=product.acceptance=required/acceptance=not_requiredfilters 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.