Alle offiziellen Dokumente aus dem Handelsregister, den Finanzbehörden und den Sozialversicherungsträgern.
Erhalten Sie in Echtzeit offizielle Dokumente über Unternehmen, Personen und Immobilien.
All das Wissen, das Sie benötigen
Hier finden Sie einige Ratschläge, die Sie berücksichtigen sollten, um sich dieser API zu nähern. Wenn Sie möchten, bieten wir Code-Beispiele, OAS3-Dokumentation, die Möglichkeit, die API live über Swagger UI auszuprobieren oder die gesamte Sammlung in Postman zu importieren. Wir bieten auch eine Sandbox-Umgebung an, in der Sie kostenlos mit allen Arten von Anfragen experimentieren können.
Nützliche Tipps für den Einstieg
DocuEngine
Holen Sie sich das Token im entsprechenden Abschnitt, bevor Sie beginnen.
Verwenden Sie das Online-Tool oder generieren Sie es über die API. Legen Sie das Ablaufdatum, einen nützlichen Namen fest und fügen Sie jetzt eine Vielzahl von Scopes hinzu, um die möglichen Aktionen Ihres Tokens zu begrenzen.
Holen Sie sich die Liste der verfügbaren Dokumente
Docuengine bietet viele Arten von Dokumenten an. Um eine Liste davon zu erhalten,
reichen Sie einfach eine Anfrage an /documents.
Das Ergebnis enthält eine Liste der verfügbaren Dokumente, die durch einen Namen, eine Kategorie und eine {id} (eine eindeutige Kennung für den Dokumenttyp), den Dokumentpreis, den Suchpreis (falls vorhanden "hasSearch": true), ob es sich um einen synchronen Dienst handelt "isSync", die Liste der Eingabefelder mit entsprechenden Erklärungen und Validierungsanweisungen "requestStructure" und die verfügbaren Optionen "options" identifiziert werden.
Achten Sie auf die Liste der Felder "fields" in "requestStructure", da diese gemäß den Validierungsregeln "validation" die erforderlichen Felder sind, die bei einer Anfrage ausgefüllt werden müssen.
Das Ergebnis enthält eine Liste der verfügbaren Dokumente, die durch einen Namen, eine Kategorie und eine {id} (eine eindeutige Kennung für den Dokumenttyp), den Dokumentpreis, den Suchpreis (falls vorhanden "hasSearch": true), ob es sich um einen synchronen Dienst handelt "isSync", die Liste der Eingabefelder mit entsprechenden Erklärungen und Validierungsanweisungen "requestStructure" und die verfügbaren Optionen "options" identifiziert werden.
Achten Sie auf die Liste der Felder "fields" in "requestStructure", da diese gemäß den Validierungsregeln "validation" die erforderlichen Felder sind, die bei einer Anfrage ausgefüllt werden müssen.
Haben Sie ausgewählt, welches Dokument Sie erhalten möchten? Stellen Sie Ihre erste Anfrage!
Nachdem wir nun die {id} des Dokuments kennen, das wir anfordern möchten, erstellen wir unsere Anfrage /requests.
Die minimal erforderlichen Daten sind tatsächlich "documentId", das wir bereits erwähnt haben, und "search", das aus den Eingabedaten des Dienstes besteht.
Im folgenden Beispiel fordern wir einen "Status" an und geben an, dass das Feld "field0" oder "taxCode" gleich "12485671007" ist, also der Steueridentifikationsnummer des Unternehmens, für das wir das Dokument anfordern.
Die Erklärung der in jedem Bericht enthaltenen Felder finden Sie im vorherigen Schritt
Die Antwort, die Sie erhalten, enthält ein Feld "id", das die eindeutige Kennung der Anfrage darstellt, sowie Informationen zum Status "state"
Für einige Arten von Anfragen können mehrere "results" vorhanden sein, aus denen Sie auswählen können. Dieses Szenario ist möglich, wenn aufgrund einer Anfrage mehrere Dokumente verfügbar sind, wie beispielsweise bei Jahresabschlüssen, bei denen Sie das Referenzjahr auswählen können, oder bei Grundbuchsuchen, bei denen Sie basierend auf einer Steuernummer auswählen können, für welche Immobilie Sie den Auszug erhalten möchten. Nur in diesem zweiten Fall ist eine nachfolgende "PATCH"-Anfrage erforderlich /requests/{id}, wobei die {id} der Anfrage im "Pfad" und die "resultId" der "results" der Suche im Body angegeben werden.
Die minimal erforderlichen Daten sind tatsächlich "documentId", das wir bereits erwähnt haben, und "search", das aus den Eingabedaten des Dienstes besteht.
Im folgenden Beispiel fordern wir einen "Status" an und geben an, dass das Feld "field0" oder "taxCode" gleich "12485671007" ist, also der Steueridentifikationsnummer des Unternehmens, für das wir das Dokument anfordern.
Die Erklärung der in jedem Bericht enthaltenen Felder finden Sie im vorherigen Schritt
{ "documentId": "6687eed51a241a5d1be0f9fa", "search": { "field0": "12485671007" } }Es wird dringend empfohlen, auch den Callback-Bereich auszufüllen, um asynchrone Statusaktualisierungen für die Anfrage zu erhalten, da die Antwortzeiten je nach Dokumenttyp variieren können.
Die Antwort, die Sie erhalten, enthält ein Feld "id", das die eindeutige Kennung der Anfrage darstellt, sowie Informationen zum Status "state"
Für einige Arten von Anfragen können mehrere "results" vorhanden sein, aus denen Sie auswählen können. Dieses Szenario ist möglich, wenn aufgrund einer Anfrage mehrere Dokumente verfügbar sind, wie beispielsweise bei Jahresabschlüssen, bei denen Sie das Referenzjahr auswählen können, oder bei Grundbuchsuchen, bei denen Sie basierend auf einer Steuernummer auswählen können, für welche Immobilie Sie den Auszug erhalten möchten. Nur in diesem zweiten Fall ist eine nachfolgende "PATCH"-Anfrage erforderlich /requests/{id}, wobei die {id} der Anfrage im "Pfad" und die "resultId" der "results" der Suche im Body angegeben werden.
{"resultId": "59eabaa38b9571eaa2520ad9672e8ee"}
Laden Sie das Dokument herunter, sobald es fertig ist!
Sobald die Anfrage den Status "state" "DONE" erreicht, stehen die Dokumente zum Download bereit.
Führen Sie einfach einen Aufruf an /requests/{id}/documents durch, um die Liste der zum Download verfügbaren Dokumente zu erhalten.
Führen Sie einfach einen Aufruf an /requests/{id}/documents durch, um die Liste der zum Download verfügbaren Dokumente zu erhalten.
[ { "fileName": "5f22f5b5065afc21cc60a27a_0.pdf", "mimeType": "application/pdf", "fileSize": "34144", "md5": "IPJJgdrAt4xrvGR4ve7oTg==", "urlExpire": 1724505599, "downloadUrl": "https://storage.googleapis.com/docuengine-openapi-com/documents/5f22f5b5065afc21cc60a27a_0.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&...." } ]
- Oas file url https://console.openapi.com/oas/de/docuengine.openapi.json
- Production domain docuengine.openapi.com
- Sandbox domain test.docuengine.openapi.com
- Production Scopes 4
-
Sandbox Scopes 4
- GET test.docuengine.openapi.com/documents
- POST test.docuengine.openapi.com/requests
- PATCH test.docuengine.openapi.com/requests
- GET test.docuengine.openapi.com/requests
Redoc missing.