v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB

Accounts: General

List Accounts

get/accounts

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.

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

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.

Provide an account status to filter results on a single account status.

person_customerboolean

If set to true, returns a simplified person customer object containing only the type and person ID, instead of the full customer details. The parameter will be deprecated in a future version of this API. Once deprecated, all responses will behave as if person_customer=true.

Headers

LMG-Data-Privacy-Access-Principalstring required

LMG-Data-Privacy-Access-Justificationstring required

Response

Successful Response

Example response

{
  "data": [
    {
      "id": "cusa_c2c3f89ec0524b6e818ce00c16e4897f",
      "customer": {
        "id": "pers_f1e3a7f504414b5e99041ebc1c0f55cd",
        "firstname": "Erika",
        "lastname": "Mustermann",
        "date_of_birth": "1964-08-13",
        "place_of_birth": {
          "city": "Berlin",
          "country": "DE"
        },
        "nationalities": [
          "DE"
        ],
        "phone_number": "+49172997318",
        "email": "erika.mustermann@example.com",
        "registered_address": {
          "line_1": "Heidestraße 17",
          "postal_code": "51147",
          "city": "Köln",
          "country": "DE"
        },
        "tax_residencies": [
          {
            "country": "DE"
          }
        ]
      },
      "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"
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "<opaque-data>"
  }
}