Get extract

import Openregister from 'openregister';

const client = new Openregister({
  apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});

const transparenzregisterExtract = await client.transparenzregister.extract.getV1('extract_id');

console.log(transparenzregisterExtract.id);

{
  "id": "<string>",
  "company_id": "<string>",
  "ekrn": "<string>",
  "reference_number": "<string>",
  "submitted_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "report": {
    "created_at": "2023-12-25",
    "notice_type": "<string>",
    "validity": {
      "from": {
        "date": "2023-12-25",
        "note": "<string>"
      },
      "until": {
        "date": "2023-12-25",
        "note": "<string>"
      }
    },
    "status_flags": {
      "deleted": true,
      "deletion_date": "2023-12-25",
      "discrepancy_note": "<string>",
      "corrected_references": [
        "<string>"
      ],
      "corrected_by_reference": "<string>"
    },
    "groups": [
      {
        "position": 123,
        "interest_type": "<string>",
        "description": "<string>"
      }
    ],
    "ubos": [
      {
        "position": 123,
        "natural_person": {
          "title": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "full_name": "<string>",
          "date_of_birth": "2023-12-25",
          "nationalities": [
            "<string>"
          ],
          "city": "<string>",
          "country": "<string>"
        },
        "interest": {
          "type": "<string>",
          "scope": "<string>",
          "percentage": 123
        }
      }
    ],
    "fictional_ubo_reason": "<string>"
  },
  "documents": [
    {
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "format": "<string>",
      "filename": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.openregister.de/llms.txt

Use this file to discover all available pages before exploring further.

​

Get Transparenzregister extract

Returns the current state of a previously ordered extract. Poll this endpoint after calling the order extract endpoint until status is completed or failed. Recommended polling interval: every 5–10 seconds. Most extracts complete within 5-60 seconds, but can take longer depending on Transparenzregister availability.

• 200 — Extract retrieved; may still be processing or terminal completed / failed
• 202 — Extract is still processing (same response schema as 200)

Do not send X-Credential-Name on this request. Polling reuses the credential mode stored when the extract was created; sandbox extracts keep using the Transparenzregister test client automatically. Once status is completed, results are cached — you can fetch the same extract_id again without re-processing or incurring additional costs. Cost: 0 credits

​

Status values

​

Top-level extract fields

​

report — parsed register entry

Derived from the JSON variant of the extract document.

​

ubos[].interest.type — enumeration

Values are the full German strings returned by the register, including legal references. Examples include:

• Beteiligung an der Vereinigung selbst, insbesondere der Höhe der Kapitalanteile (§ 19 Abs. 3 Nr. 1a GwG)
• Beteiligung an der Vereinigung selbst, insbesondere der Stimmrechte (§ 19 Abs. 3 Nr. 1a GwG)
• Ausübung von Kontrolle auf sonstige Weise (§ 19 Abs. 3 Nr. 1b GwG)
• Treugeber (Settlor), Trustee oder Protektor (§ 3 Abs. 3 Nr. 1 GwG)
• Mitglied des Vorstands der Stiftung (§ 3 Abs. 3 Nr. 2 GwG)
• Begünstigter (§ 3 Abs. 3 Nr. 3 GwG)
• Person mit sonstigem beherrschendem Einfluss auf Vermögensverwaltung / Ertragsverteilung (§ 3 Abs. 3 Nr. 5 GwG)
• Sonstige Funktion des gesetzlichen Vertreters (§ 19 Abs. 3 Nr. 1c GwG)
• Funktion des geschäftsführenden Gesellschafters oder Partners (§ 19 Abs. 3 Nr. 1c GwG)
• Person mit beherrschendem Einfluss nach § 3 Abs. 3 Nr. 6 GwG
• Funktion des gesetzlichen Vertreters, geschäftsführenden Gesellschafters oder Partners (§ 19 Abs. 3 Nr. 1c GwG)
• Person mit beherrschendem Einfluss auf eine Vereinigung, die Mitglied des Vorstands der Stiftung ist oder die als Begünstigte der Stiftung bestimmt worden ist (§ 3 Abs. 3 Nr. 6a GwG)
• Person mit beherrschendem Einfluss auf eine Vereinigung, die als Treugeber (Settlor), Verwalter von Trusts (Trustee) oder Protektor handelt oder die als Begünstigte der Rechtseinheit bestimmt worden ist (§ 3 Abs. 3 Nr. 6b GwG)

​

fictional_ubo_reason — upstream grundFiktiveWb

When set, typical values include:

• Es wurde keine natürliche Person ermittelt, die die Voraussetzungen eines wirtschaftlich Berechtigten nach § 3 Abs. 1 oder Abs. 2 S. 1 - 4 GwG erfüllt.
• Die Ermittlung eines wirtschaftlich Berechtigten nach § 3 Abs. 1 oder Abs. 2 S. 1 - 4 GwG war nach Durchführung umfassender Prüfungen nicht möglich.
• keine Angabe

​

documents[]