Sign in

v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB
Accounts: General

Accept Agreement

post/accounts/{account}/accept_agreement

Path parameters

accountstring required

An account identifier.

Headers

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

Request body

personstring required

A person identifier specifying the individual accepting the agreement.

agreementstring required

An agreement identifier specifying which agreement is being accepted.

accepted_atstring date-time required

The timestamp when the agreement was accepted.

Example request

{
  "person": "pers_8ec894e1ec764a339e172292dff9aeff",
  "agreement": "agr_8ec894e1ec764a339e172292dff9aeff",
  "accepted_at": "2023-06-29T14:39:29Z"
}

Response

Successful Response

idstring required

A value identifiying the individual user's account.

declaration_of_acting_on_own_accountboolean required

An boolean value indicating whether the user has explicitly stated that they are acting on their own account and not in someone else's name.

status'closed' | 'created' | 'opened' | 'rejected' required

A category representing the status of a user's account.

<ul> <li><code>closed</code> <li><code>created</code> <li><code>opened</code> <li><code>rejected</code> </ul> <strong>NOTE:</strong> This list is not final yet, there will be more values added later.
metadataobject

Optional metadata for the account as key-value pairs.

Example response

{
  "id": "cusa_c2c3f89ec0524b6e818ce00c16e4897f",
  "customer": {
    "id": "pers_f1e3a7f504414b5e99041ebc1c0f55cd",
    "person": "pers_f1e3a7f504414b5e99041ebc1c0f55cd"
  },
  "history": [
    {
      "status": "created",
      "timestamp": "2023-06-23T07:29:55.465000+00:00"
    }
  ],
  "agreements": [
    {
      "agreement": "agr_9902271f791d413aad781763c61b9bb0",
      "accepted_at": "2023-06-29T14:39:29Z",
      "person": "per_3a0baf04657b4fb9bcaa03d8120b5e9e"
    },
    {
      "agreement": "agr_8ec894e1ec764a339e172292dff9aeff",
      "accepted_at": "2023-06-29T14:39:29Z",
      "person": "per_3a0baf04657b4fb9bcaa03d8120b5e9e"
    }
  ]
}