Get Latest Agreements

When opening an account, the user has to agree to accept certain types of contractual documents, like privacy policy or terms and conditions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A pagination cursor. When you receive a paginated response containing the property pagination.next_cursor, you can pass its value here to get the next page of results for your query.
A cursor will include filter parameters, so there is not need to specify both the cursor and any other filter parameter.

integer
1 to 100
Defaults to 100

In order to customize the number of elements returned, you can provide a limit here. The service will not return more elements than specified.

string
enum

Filter agreements by their scope.

  • platform: return only platform-wide agreements (those that apply regardless of product).
  • product: return only agreements tied to a specific product. Requires the product parameter to be set.

Combining scope=platform with a product value is invalid and results in a 400 response.

Allowed:
string
enum

Filter agreements by the product they are tied to, e.g. brokerage or retirement_account. This parameter is only valid together with scope=product; supplying it on its own or alongside scope=platform results in a 400 response.

Allowed:
string
enum

Filter agreements by whether the customer must actively accept them.

  • required: return only agreements that require active acceptance.
  • not_required: return only informational agreements that do not require acceptance.

Can be combined with the scope (and product) filters.

Allowed:
Headers
string
required
string
required
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json