LElemon
Documents

Get Document

get/accounts/{account_id}/documents/{document_id}

Request

Path parameters

account_idstring required

An account identifier.

document_idstring required

A document identifier.

Headers

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

Response

Successful Response

idstring required

A string representing the unique identifier of this document.

created_atstring date-time required

The timestamp of the document. It represents the point in time at which the document was created for the user.

namestring required

A string identifying the document, suitable to be displayed to the user.

urlstring uri required

A reference to the actual document. You can use this URL to present the document to the user. It can be accessed without special headers like Authorization or the LMG-Data-Privacy-* ones, so you have full flexibility for presentation and you can choose among:

<ol><!-- redocly preview doesn't support markdown lists --> <li>Showing the document using an In-App Browser. <li>Showing the document using an external Browser App. <li>Provide the user with your own options to download or forward the document. </ol> <strong>NOTE:</strong> The URLs returned here will expire after a certain period of time. We suggest to ignore document URLs when listing documents, e.g. in a postbox. When the user wants to view a document, we recommend to perform a `GET` request using the `doc_…` identifier. This will provide you with a fresh document URL that can be safely used to display the document irregardless of link expiry.
languagestring required

The (natural) language for the document. This will can either be a pure language code like "de" or "pl" or a regional language code like "en_GB" or "de_CH".

<ul> <li><strong>Pure language code</strong> in this case is an ISO 639-1 alpha-2 code. <li><strong>Regional language code</strong> in this case is the concatenation of an ISO 639-1 alpha-2 code for a language joined using the underscore character (<code>_</code>) with an ISO 3166-1 alpha-2 code for a country. </ul>
type'account_statement' | 'cash.statement' | 'contractual' | 'general' | 'income_distribution.receipt' | 'order.cost' | 'report.ex_post' | 'tax_information' | 'tax.receipt' | 'tax.statement' | 'trade.receipt' required

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.
content_type'application/pdf' required

A category representing the content type of the document displayed. At the moment, there will only be one content type for documents:

<ul> <li><code>application/pdf</code> </ul> A potential use-case for this attribute is an icon used as a file-type indicator in a list of documents.

Example response

{
  "id": "doc_8e2a16591a664df89551047d85436562",
  "name": "Datenschutzerklärung",
  "language": "de"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.