LElemon
Documents

Get Latest Agreements

Changed on

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

get/agreements

Request

Query parameters

cursorstring

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.

limitinteger

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

scope'platform' | 'product'

Describes whether an agreement applies platform-wide or is tied to a specific product.

<ul> <li><code>platform</code>: the agreement applies regardless of product (for example the privacy policy or terms and conditions). <li><code>product</code>: the agreement is tied to a specific product, which is exposed via the <code>product</code> property. </ul>

Filter agreements by their scope.

<ul> <li><code>platform</code>: return only platform-wide agreements (those that apply regardless of product). <li><code>product</code>: return only agreements tied to a specific product. Requires the <code>product</code> parameter to be set. </ul> Combining <code>scope=platform</code> with a <code>product</code> value is invalid and results in a <code>400</code> response.
product'brokerage' | 'retirement_account'

The type of product an entity is associated with.

<ul> <li><code>brokerage</code>: the lemon.markets brokerage product. <li><code>retirement_account</code>: the lemon.markets retirement account (Altersvorsorgedepot) product. </ul>

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

acceptance'required' | 'not_required'

Describes whether the customer must actively accept an agreement.

<ul> <li><code>required</code>: the customer must actively accept this agreement. <li><code>not_required</code>: the agreement is informational and does not require active acceptance. </ul>

Filter agreements by whether the customer must actively accept them.

<ul> <li><code>required</code>: return only agreements that require active acceptance. <li><code>not_required</code>: return only informational agreements that do not require acceptance. </ul> Can be combined with the <code>scope</code> (and <code>product</code>) filters.

Headers

LMG-Data-Privacy-Access-Principalstring required
LMG-Data-Privacy-Access-Justificationstring required

Response

Successful Response

Example response

{
  "data": [
    {
      "effective_at": "2024-01-15T09:30:00.000000+00:00"
    }
  ],
  "pagination": {
    "next_cursor": "<opaque-data>"
  }
}

Changes

  • 1f1df208c0e4Revision changes
    • info

      added the new optional query request parameter acceptance

    • info

      added the new optional query request parameter product

    • info

      added the new optional query request parameter scope

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status