Document Realtime

GET /v1/document

JavaScript

JavaScript

import Openregister from 'openregister';

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

const response = await client.document.getRealtimeV1({
  company_id: 'company_id',
  document_category: 'current_printout',
});

console.log(response.category);

200

{
  "url": "<string>",
  "file_date": "<string>",
  "file_name": "<string>"
}

Retrieve realtime documents for a company

Request official documents directly from the Handelsregister in real-time. This endpoint fetches documents on-demand from the official register, ensuring you always receive the most current version available.

Cost: 10 credits

Available Document Types

You can retrieve several types of official documents by specifying the document_category parameter:

• current_printout (AD) - Current register extract showing the company’s current state (PDF)
• chronological_printout (CD) - Complete historical extract showing all changes (PDF)
• historical_printout (HD) - Historical snapshot from a previous point in time (PDF)
• shareholder_list (GV) - Official shareholder list (Gesellschafterliste) (PDF)
• articles_of_association (UT) - Company articles/bylaws (Satzung/Gesellschaftsvertrag) (PDF)
• structured_information (SI) - Structured company data (XML format)

Most documents are returned as PDF files that can be downloaded and archived, except for structured_information which is provided in XML format for programmatic processing. These are the same official documents you would receive from the Handelsregister portal, but accessible via API.

Use Cases

Legal Documentation: Lawyers and notaries use this endpoint to obtain official, certified register extracts for transactions, litigation, or regulatory filings. The current printout (AD) is commonly required for contracts and due diligence.

Compliance Archiving: Maintain audit trails by periodically downloading and archiving official documents. Keep historical snapshots for regulatory compliance and documentation requirements.

Automated Verification: Integrate document retrieval into your workflows to automatically obtain proof of registration, current ownership, or corporate structure whenever needed for client onboarding or transaction processing.

Authorizations

Authorization · string · header · required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Query Parameters

company_id · string · required

document_category · enum<string> · required

Available options: current_printout, chronological_printout, historical_printout, structured_information, shareholder_list, articles_of_association

Response

200

application/json

Success

url · string<uri> · required

category · enum<string> · required

Available options: current_printout, chronological_printout, historical_printout, structured_information, shareholder_list, articles_of_association

file_date · string | null · required

file_name · string | null · required