Sign in

v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB
Documents

List Documents

get/accounts/{account_id}/documents

Path parameters

account_idstring required

An account identifier.

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.

type'account_statement' | 'cash.statement' | 'contractual' | 'general' | 'income_distribution.receipt' | 'order.cost' | 'report.ex_post' | 'tax_information' | 'tax.receipt' | 'tax.statement' | 'trade.receipt'

A category representing the type of document:

<ul> <li><code>account_statement</code>: An account statements, e.g. quarterly statements for both the reference account and the securities account. <li><code>cash.statement</code>: A statement detailing cash movements and balances for a specific period, e.g. the quarterly cash statement. <li><code>contractual</code>: A contractual document, e.g. private policy or terms and conditions. <li><code>general</code>: A document with general information, e.g. basic information on securities trading. <li><code>income_distribution.receipt</code>: A document presenting detailed information about an income distribution. <li><code>report.ex_post</code>: The annual cost report. <li><code>order.cost</code>: A cost information document for an order. <li><code>tax_information</code>: deprecated <li><code>tax.receipt</code>: Tax related information about a specific payment, e.g. for capital gains tax on unrealized gains (German Vorabpauschale) or refunds due to tax optimization. <li><code>tax.statement</code>: Tax reporting information, e.g. the annual tax reporting. <li><code>trade.receipt</code>: A trade receipt: It presents final information about prices, cost and quantities. </ul> <strong>Note:</strong> This list is not final, there will be more types added over time.

Headers

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

Response

Successful Response

Example response

{
  "data": [
    {
      "id": "doc_8e2a16591a664df89551047d85436562",
      "name": "Datenschutzerklärung",
      "language": "de"
    }
  ],
  "pagination": {
    "next_cursor": "<opaque-data>"
  }
}