OpenAPI-Referenz
Durchsuchbare Referenz der Kunden-API mit vollständigen Anfrage- und Antwortschemas sowie OpenAPI-Datei zum Herunterladen.
Hier finden Sie die unterstützten Aufrufe für Ihre Integration: Aufträge erstellen und verwalten, Ergebnisse abrufen sowie Guthaben und Buchungen lesen. Den vollständigen Ablauf erklärt der API-Schnellstart.
OpenAPI-Datei herunterladen (JSON)
Sie können die Datei in einen API-Client importieren oder daraus einen Client generieren. Die Beispiele verwenden fiktive Daten. Ersetzen Sie diese und alle Kennungen vor einem Aufruf durch Ihre eigenen Werte.
Basis-URL und Authentifizierung
https://api.krake.run
Senden Sie Ihren API-Schlüssel im Header X-API-Key. Erstellen Sie einen Schlüssel in der Konsole unter API-Schlüssel und senden Sie ihn bei jeder Anfrage. https://krake.run/docs/authentication
API-Schlüssel erstellen und verwalten Sie in der Konsole. Weitere Informationen: Authentifizierung und Limits & Fehler.
API-Aufrufe
51 Aufrufe
Anreicherung
Unternehmens- und Kontaktdaten ergänzen.
POST /api/v1/enrichment/batches/ Einzelabfrage starten
Einzelabfrage mit höchstens 50 Eingabefeldern. Jeder angenommene POST erzeugt einen neuen Auftrag; keine automatische Wiederholung nach Verbindungsabbrüchen. Limit: 60 Anfragen pro Minute. HTTP 202 liefert batch_id und record_id. Fragen Sie anschließend den Auftragsstatus und records/{id}/ ab.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: application/json
Einzelabfrage
{
"input_data": {
"company_domain": "beispielbusiness.de"
}
} Antworten
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die Einzelabfrage nicht aus.
Inhaltstyp: application/json
GET /api/v1/enrichment/batches/{id}/ Auftrag und Fortschritt abrufen
Status, Fortschritt, Kosten und Zahlungssperre eines eigenen Auftrags abrufen. Die Historie bleibt nach dem Löschen der Ergebnisse verfügbar; results_purged_at zeigt die Löschung an.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/enrichment/batches/{id}/cancel/ Auftrag stoppen
Einen Auftrag im Status validating, queued oder processing stoppen. Bereits abgeschlossene Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
GET /api/v1/enrichment/batches/{id}/export/ Ergebnisse als CSV herunterladen
CSV-Download (UTF-8) mit Content-Disposition-Dateiname. Erst nach Abschluss oder Stopp verfügbar; unbezahlte Ergebnisse werden nicht freigegeben. standard und full enthalten die Zeilen mit Ergebnis. standard begrenzt Listen auf drei Einträge, full enthält alle. without_result enthält die übrigen Eingabezeilen samt grund und eignet sich für einen erneuten Upload.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"csv","json" idpath Pflichtfeld-
stringuuid layoutquery-
Umfang und Zeilenauswahl des Exports.
stringZulässige Werte:
"full","standard","without_result"Standard:
"standard"
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
200 CSV-Datei als Download.
Antwortheader:
Content-Dispositionattachment; filename=…
string
Inhaltstyp: text/csv
string binary GET /api/v1/enrichment/batches/{id}/progress/ Fortschritt als Ereignisstrom verfolgen
Antwort als text/event-stream: data: {JSON} gefolgt von einer Leerzeile. Sofortiger Status, danach Fortschrittsmeldungen und etwa alle 15 Sekunden eine Statusmeldung. Der Stream endet bei completed, partially_completed, failed oder cancelled. Senden Sie X-API-Key z. B. mit curl -N oder fetch; Browser-EventSource unterstützt diesen Header nicht. Das Datenobjekt enthält batch_id, status, total_records, pending_records, processing_records, completed_records, failed_records, retryable_records, result_records, uncharged_records, progress_percent, estimated_completion_at und eta_seconds_remaining.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"event-stream","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
200 SSE-Text mit JSON-Daten je Ereignis. Cache-Control: no-cache.
Inhaltstyp: text/event-stream
string Fortschritt
data: {"batch_id":"11111111-1111-4111-8111-111111111111","status":"processing","total_records":10,"pending_records":5,"processing_records":1,"completed_records":4,"failed_records":0,"retryable_records":0,"result_records":4,"uncharged_records":0,"progress_percent":40.0,"estimated_completion_at":null,"eta_seconds_remaining":null}
GET /api/v1/enrichment/batches/{id}/records/ Datensätze eines Auftrags abrufen
Datensätze in Upload-Reihenfolge, index ab 1. Folgen Sie next bis null. result ist vor Abschluss, bei einem Fehler oder ausstehender Zahlung null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid pagequery-
Seitennummer ab 1.
integer page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
1000Minimum:
1Maximum:
1000
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/enrichment/batches/{id}/restart/ Fehlgeschlagene Datensätze erneut versuchen
Nur erneut versuchbare fehlgeschlagene Zeilen eines Auftrags mit Status cancelled, failed oder partially_completed starten. Bereits fertige Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/enrichment/batches/{id}/retry-billing/ Offene Ergebnisse eines Auftrags bezahlen
Offene Ergebnisse eines Auftrags nach einer Aufladung bezahlen. Voraussetzung: billing_paused=true. Reicht das Guthaben nur teilweise, bleibt billing_paused=true; bereits bezahlte Ergebnisse werden nicht erneut berechnet.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/enrichment/batches/csv/ CSV-Auftrag starten
Eine CSV-Datei mit Kopfzeile hochladen: höchstens 10 MiB und 50.000 Datenzeilen. Trennzeichen Komma, Semikolon oder Tabulator werden erkannt. UTF-8 (mit/ohne BOM), Windows-1252 und Latin-1 werden unterstützt, UTF-16 nicht. Senden Sie Arrays als wiederholte Multipart-Felder; original_columns ist ein JSON-kodierter String. Limit: 10 Uploads/Minute. Jeder angenommene Upload erzeugt einen neuen Auftrag. Verwenden Sie die dokumentierten Eingabefelder als Spaltennamen: https://krake.run/docs/input-columns.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: multipart/form-data
Antworten
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die geschätzten Auftragskosten nicht aus.
Inhaltstyp: application/json
413 Die HTTP-Anfrage überschreitet das Größenlimit des Servers.
Inhaltstyp: application/json
GET /api/v1/enrichment/batches/list/ Aufträge auflisten
Eigene Aufträge dieses Produkts, neueste zuerst. Die Auftragshistorie bleibt auch nach dem Löschen der Ergebnisse erhalten.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
cursorquery-
Undurchsichtiger Cursor. Folgen Sie der URL in next oder previous.
string page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
50Minimum:
1Maximum:
1000 via_apiquery-
Aufträge mit API-Schlüssel (true) oder aus der Konsole (false). Ohne Filter: beide.
boolean
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/enrichment/batches/retry-billing/ Offene Ergebnisse dieses Produkts bezahlen
Bezahlt offene Ergebnisse dieses Produkts, älteste Aufträge zuerst, solange das Guthaben reicht. Aufladungen lösen dies auch automatisch aus. charged ist die Zahl der jetzt bezahlten Ergebnisse.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
GET /api/v1/enrichment/records/{id}/ Ein Datensatzergebnis abrufen
Eingabe und Ergebnis eines eigenen Datensatzes dieses Produkts. Gelöschte Datensätze liefern 404. payment_pending zeigt eine ausstehende Zahlung an; result bleibt dann null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
Impressum Scraper
Daten aus dem Impressum einer Website.
POST /api/v1/imprint-scraper/batches/ Einzelabfrage starten
Einzelabfrage mit höchstens 50 Eingabefeldern. Jeder angenommene POST erzeugt einen neuen Auftrag; keine automatische Wiederholung nach Verbindungsabbrüchen. Limit: 60 Anfragen pro Minute. HTTP 202 liefert batch_id und record_id. Fragen Sie anschließend den Auftragsstatus und records/{id}/ ab.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: application/json
Einzelabfrage
{
"input_data": {
"company_domain": "beispielbusiness.de"
}
} Antworten
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die Einzelabfrage nicht aus.
Inhaltstyp: application/json
GET /api/v1/imprint-scraper/batches/{id}/ Auftrag und Fortschritt abrufen
Status, Fortschritt, Kosten und Zahlungssperre eines eigenen Auftrags abrufen. Die Historie bleibt nach dem Löschen der Ergebnisse verfügbar; results_purged_at zeigt die Löschung an.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/imprint-scraper/batches/{id}/cancel/ Auftrag stoppen
Einen Auftrag im Status validating, queued oder processing stoppen. Bereits abgeschlossene Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
GET /api/v1/imprint-scraper/batches/{id}/export/ Ergebnisse als CSV herunterladen
CSV-Download (UTF-8) mit Content-Disposition-Dateiname. Erst nach Abschluss oder Stopp verfügbar; unbezahlte Ergebnisse werden nicht freigegeben. Ein vollständiger Export mit allen fertigen Zeilen; kein layout-Parameter.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"csv","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
200 CSV-Datei als Download.
Antwortheader:
Content-Dispositionattachment; filename=…
string
Inhaltstyp: text/csv
string binary GET /api/v1/imprint-scraper/batches/{id}/progress/ Fortschritt als Ereignisstrom verfolgen
Antwort als text/event-stream: data: {JSON} gefolgt von einer Leerzeile. Sofortiger Status, danach Fortschrittsmeldungen und etwa alle 15 Sekunden eine Statusmeldung. Der Stream endet bei completed, partially_completed, failed oder cancelled. Senden Sie X-API-Key z. B. mit curl -N oder fetch; Browser-EventSource unterstützt diesen Header nicht. Das Datenobjekt enthält batch_id, status, total_records, pending_records, processing_records, completed_records, failed_records, retryable_records, result_records, uncharged_records, progress_percent, estimated_completion_at und eta_seconds_remaining.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"event-stream","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
200 SSE-Text mit JSON-Daten je Ereignis. Cache-Control: no-cache.
Inhaltstyp: text/event-stream
string Fortschritt
data: {"batch_id":"11111111-1111-4111-8111-111111111111","status":"processing","total_records":10,"pending_records":5,"processing_records":1,"completed_records":4,"failed_records":0,"retryable_records":0,"result_records":4,"uncharged_records":0,"progress_percent":40.0,"estimated_completion_at":null,"eta_seconds_remaining":null}
GET /api/v1/imprint-scraper/batches/{id}/records/ Datensätze eines Auftrags abrufen
Datensätze in Upload-Reihenfolge, index ab 1. Folgen Sie next bis null. result ist vor Abschluss, bei einem Fehler oder ausstehender Zahlung null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid pagequery-
Seitennummer ab 1.
integer page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
1000Minimum:
1Maximum:
1000
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/imprint-scraper/batches/{id}/restart/ Fehlgeschlagene Datensätze erneut versuchen
Nur erneut versuchbare fehlgeschlagene Zeilen eines Auftrags mit Status cancelled, failed oder partially_completed starten. Bereits fertige Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/imprint-scraper/batches/{id}/retry-billing/ Offene Ergebnisse eines Auftrags bezahlen
Offene Ergebnisse eines Auftrags nach einer Aufladung bezahlen. Voraussetzung: billing_paused=true. Reicht das Guthaben nur teilweise, bleibt billing_paused=true; bereits bezahlte Ergebnisse werden nicht erneut berechnet.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/imprint-scraper/batches/csv/ CSV-Auftrag starten
Eine CSV-Datei mit Kopfzeile hochladen: höchstens 10 MiB und 50.000 Datenzeilen. Trennzeichen Komma, Semikolon oder Tabulator werden erkannt. UTF-8 (mit/ohne BOM), Windows-1252 und Latin-1 werden unterstützt, UTF-16 nicht. Senden Sie Arrays als wiederholte Multipart-Felder; original_columns ist ein JSON-kodierter String. Limit: 10 Uploads/Minute. Jeder angenommene Upload erzeugt einen neuen Auftrag. Verwenden Sie die dokumentierten Eingabefelder als Spaltennamen: https://krake.run/docs/input-columns.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: multipart/form-data
Antworten
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die geschätzten Auftragskosten nicht aus.
Inhaltstyp: application/json
413 Die HTTP-Anfrage überschreitet das Größenlimit des Servers.
Inhaltstyp: application/json
GET /api/v1/imprint-scraper/batches/list/ Aufträge auflisten
Eigene Aufträge dieses Produkts, neueste zuerst. Die Auftragshistorie bleibt auch nach dem Löschen der Ergebnisse erhalten.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
cursorquery-
Undurchsichtiger Cursor. Folgen Sie der URL in next oder previous.
string page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
50Minimum:
1Maximum:
1000 via_apiquery-
Aufträge mit API-Schlüssel (true) oder aus der Konsole (false). Ohne Filter: beide.
boolean
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/imprint-scraper/batches/retry-billing/ Offene Ergebnisse dieses Produkts bezahlen
Bezahlt offene Ergebnisse dieses Produkts, älteste Aufträge zuerst, solange das Guthaben reicht. Aufladungen lösen dies auch automatisch aus. charged ist die Zahl der jetzt bezahlten Ergebnisse.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
GET /api/v1/imprint-scraper/records/{id}/ Ein Datensatzergebnis abrufen
Eingabe und Ergebnis eines eigenen Datensatzes dieses Produkts. Gelöschte Datensätze liefern 404. payment_pending zeigt eine ausstehende Zahlung an; result bleibt dann null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
E-Mail-Prüfung
Eine E-Mail-Adresse oder eine CSV-Liste prüfen.
POST /api/v1/email-verification/batches/ Einzelabfrage starten
Einzelabfrage mit höchstens 50 Eingabefeldern. Jeder angenommene POST erzeugt einen neuen Auftrag; keine automatische Wiederholung nach Verbindungsabbrüchen. Limit: 60 Anfragen pro Minute. Die Anfrage wartet kurz auf das Ergebnis (standardmäßig bis zu 10 Sekunden). HTTP 200 enthält den abgeschlossenen Datensatz, HTTP 202 den noch laufenden Datensatz. Fragen Sie dann records/{id}/ ab.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: application/json
Einzelabfrage
{
"input_data": {
"email": "info@beispielbusiness.de"
}
} Antworten
200
Inhaltstyp: application/json
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die Einzelabfrage nicht aus.
Inhaltstyp: application/json
GET /api/v1/email-verification/batches/{id}/ Auftrag und Fortschritt abrufen
Status, Fortschritt, Kosten und Zahlungssperre eines eigenen Auftrags abrufen. Die Historie bleibt nach dem Löschen der Ergebnisse verfügbar; results_purged_at zeigt die Löschung an.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/email-verification/batches/{id}/cancel/ Auftrag stoppen
Einen Auftrag im Status validating, queued oder processing stoppen. Bereits abgeschlossene Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
GET /api/v1/email-verification/batches/{id}/export/ Ergebnisse als CSV herunterladen
CSV-Download (UTF-8) mit Content-Disposition-Dateiname. Erst nach Abschluss oder Stopp verfügbar; unbezahlte Ergebnisse werden nicht freigegeben. Ein vollständiger Export mit allen fertigen Zeilen; kein layout-Parameter.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"csv","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
200 CSV-Datei als Download.
Antwortheader:
Content-Dispositionattachment; filename=…
string
Inhaltstyp: text/csv
string binary GET /api/v1/email-verification/batches/{id}/progress/ Fortschritt als Ereignisstrom verfolgen
Antwort als text/event-stream: data: {JSON} gefolgt von einer Leerzeile. Sofortiger Status, danach Fortschrittsmeldungen und etwa alle 15 Sekunden eine Statusmeldung. Der Stream endet bei completed, partially_completed, failed oder cancelled. Senden Sie X-API-Key z. B. mit curl -N oder fetch; Browser-EventSource unterstützt diesen Header nicht. Das Datenobjekt enthält batch_id, status, total_records, pending_records, processing_records, completed_records, failed_records, retryable_records, result_records, uncharged_records, progress_percent, estimated_completion_at und eta_seconds_remaining.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"event-stream","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
200 SSE-Text mit JSON-Daten je Ereignis. Cache-Control: no-cache.
Inhaltstyp: text/event-stream
string Fortschritt
data: {"batch_id":"11111111-1111-4111-8111-111111111111","status":"processing","total_records":10,"pending_records":5,"processing_records":1,"completed_records":4,"failed_records":0,"retryable_records":0,"result_records":4,"uncharged_records":0,"progress_percent":40.0,"estimated_completion_at":null,"eta_seconds_remaining":null}
GET /api/v1/email-verification/batches/{id}/records/ Datensätze eines Auftrags abrufen
Datensätze in Upload-Reihenfolge, index ab 1. Folgen Sie next bis null. result ist vor Abschluss, bei einem Fehler oder ausstehender Zahlung null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid pagequery-
Seitennummer ab 1.
integer page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
1000Minimum:
1Maximum:
1000
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/email-verification/batches/{id}/restart/ Fehlgeschlagene Datensätze erneut versuchen
Nur erneut versuchbare fehlgeschlagene Zeilen eines Auftrags mit Status cancelled, failed oder partially_completed starten. Bereits fertige Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/email-verification/batches/{id}/retry-billing/ Offene Ergebnisse eines Auftrags bezahlen
Offene Ergebnisse eines Auftrags nach einer Aufladung bezahlen. Voraussetzung: billing_paused=true. Reicht das Guthaben nur teilweise, bleibt billing_paused=true; bereits bezahlte Ergebnisse werden nicht erneut berechnet.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/email-verification/batches/csv/ CSV-Auftrag starten
Eine CSV-Datei mit Kopfzeile hochladen: höchstens 100 MiB und 1.000.000 Datenzeilen. Trennzeichen Komma, Semikolon oder Tabulator werden erkannt. UTF-8 (mit/ohne BOM), Windows-1252 und Latin-1 werden unterstützt, UTF-16 nicht. Senden Sie Arrays als wiederholte Multipart-Felder; original_columns ist ein JSON-kodierter String. Limit: 10 Uploads/Minute. Jeder angenommene Upload erzeugt einen neuen Auftrag. Verwenden Sie die dokumentierten Eingabefelder als Spaltennamen: https://krake.run/docs/input-columns.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: multipart/form-data
Antworten
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die geschätzten Auftragskosten nicht aus.
Inhaltstyp: application/json
413 Die HTTP-Anfrage überschreitet das Größenlimit des Servers.
Inhaltstyp: application/json
GET /api/v1/email-verification/batches/list/ Aufträge auflisten
Eigene Aufträge dieses Produkts, neueste zuerst. Die Auftragshistorie bleibt auch nach dem Löschen der Ergebnisse erhalten.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
cursorquery-
Undurchsichtiger Cursor. Folgen Sie der URL in next oder previous.
string page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
50Minimum:
1Maximum:
1000 via_apiquery-
Aufträge mit API-Schlüssel (true) oder aus der Konsole (false). Ohne Filter: beide.
boolean
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/email-verification/batches/retry-billing/ Offene Ergebnisse dieses Produkts bezahlen
Bezahlt offene Ergebnisse dieses Produkts, älteste Aufträge zuerst, solange das Guthaben reicht. Aufladungen lösen dies auch automatisch aus. charged ist die Zahl der jetzt bezahlten Ergebnisse.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
POST /api/v1/email-verification/check/ Eine Adresse ohne API-Schlüssel prüfen
Kostenlos und ohne API-Schlüssel: 100 Prüfungen pro IP-Adresse und Tag (UTC), IPv6-Adressen nach ihrem /64-Netz. result ist dasselbe wie bei der Einzelabfrage mit API-Schlüssel. Es entsteht kein Auftrag und keine Buchung. Eine Prüfung ohne Ergebnis (503) zählt nicht. Zusätzlich gelten 30 Anfragen pro Minute. Nur application/json; Websites erhalten keine CORS-Freigabe, Prüfungen aus dem Browser Ihrer Besucher sind also nicht vorgesehen. Mehr Adressen prüfen Sie mit einem API-Schlüssel.
Ohne Anmeldung verfügbar. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: application/json
Kostenlose Prüfung
{
"email": "info@beispielbusiness.de"
} Antworten
200 Das Ergebnis, wie es eine Einzelabfrage in result liefert.
Antwortheader:
RateLimit-LimitKostenlose Prüfungen pro IP-Adresse und Tag.
integerRateLimit-RemainingHeute noch verbleibende Prüfungen dieser IP-Adresse.
integerRateLimit-ResetSekunden bis zum nächsten Tag (UTC), an dem das Limit neu beginnt.
integer
Inhaltstyp: application/json
400 Keine oder mehr als eine E-Mail-Adresse.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
415 Der Anfragekörper ist kein application/json.
Inhaltstyp: application/json
429 Tageslimit erreicht, oder mehr als 30 Anfragen pro Minute.
Antwortheader:
RateLimit-LimitKostenlose Prüfungen pro IP-Adresse und Tag.
integerRateLimit-RemainingHeute noch verbleibende Prüfungen dieser IP-Adresse.
integerRateLimit-ResetSekunden bis zum nächsten Tag (UTC), an dem das Limit neu beginnt.
integerRetry-AfterSekunden bis zum nächsten Versuch.
integer
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 Kein Ergebnis, etwa weil die Prüfung ausgelastet ist. Die Prüfung zählt nicht.
Antwortheader:
Retry-AfterSekunden bis zum nächsten Versuch.
integer
Inhaltstyp: application/json
GET /api/v1/email-verification/records/{id}/ Ein Datensatzergebnis abrufen
Eingabe und Ergebnis eines eigenen Datensatzes dieses Produkts. Gelöschte Datensätze liefern 404. payment_pending zeigt eine ausstehende Zahlung an; result bleibt dann null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
Anrede ergänzen
Fehlende Anreden anhand einer lokalen Vornamentabelle ergänzen. Quellen: Bundesamt für Statistik (BFS), STATPOP (https://opendata.swiss/de/dataset/weibliche-vornamen-der-bevolkerung-nach-jahrgang-schweiz-2025); Stadt Duisburg (CC BY 3.0 DE, https://opendata-duisburg.de/dataset/rufnamen-aller-einwohnerinnen); Stadt Bielefeld (CC BY 4.0, https://open-data.bielefeld.de/dataset/vornamen-bielefeld).
POST /api/v1/salutation/batches/ Einzelabfrage starten
Einzelabfrage mit höchstens 50 Eingabefeldern. Jeder angenommene POST erzeugt einen neuen Auftrag; keine automatische Wiederholung nach Verbindungsabbrüchen. Limit: 60 Anfragen pro Minute. Die Antwort enthält das Ergebnis sofort (HTTP 200). Bestehende Anreden und unbekannte/mehrdeutige Namen bleiben kostenlos.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: application/json
Einzelabfrage
{
"input_data": {
"first_name": "Max"
}
} Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die Einzelabfrage nicht aus.
Inhaltstyp: application/json
GET /api/v1/salutation/batches/{id}/ Auftrag und Fortschritt abrufen
Status, Fortschritt, Kosten und Zahlungssperre eines eigenen Auftrags abrufen. Die Historie bleibt nach dem Löschen der Ergebnisse verfügbar; results_purged_at zeigt die Löschung an.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/salutation/batches/{id}/cancel/ Auftrag stoppen
Einen Auftrag im Status validating, queued oder processing stoppen. Bereits abgeschlossene Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
GET /api/v1/salutation/batches/{id}/export/ Ergebnisse als CSV herunterladen
CSV-Download (UTF-8) mit Content-Disposition-Dateiname. Erst nach Abschluss oder Stopp verfügbar; unbezahlte Ergebnisse werden nicht freigegeben. Ein vollständiger Export mit allen fertigen Zeilen; kein layout-Parameter.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"csv","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
200 CSV-Datei als Download.
Antwortheader:
Content-Dispositionattachment; filename=…
string
Inhaltstyp: text/csv
string binary GET /api/v1/salutation/batches/{id}/progress/ Fortschritt als Ereignisstrom verfolgen
Antwort als text/event-stream: data: {JSON} gefolgt von einer Leerzeile. Sofortiger Status, danach Fortschrittsmeldungen und etwa alle 15 Sekunden eine Statusmeldung. Der Stream endet bei completed, partially_completed, failed oder cancelled. Senden Sie X-API-Key z. B. mit curl -N oder fetch; Browser-EventSource unterstützt diesen Header nicht. Das Datenobjekt enthält batch_id, status, total_records, pending_records, processing_records, completed_records, failed_records, retryable_records, result_records, uncharged_records, progress_percent, estimated_completion_at und eta_seconds_remaining.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
formatquery-
stringZulässige Werte:
"event-stream","json" idpath Pflichtfeld-
stringuuid
Antworten
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
200 SSE-Text mit JSON-Daten je Ereignis. Cache-Control: no-cache.
Inhaltstyp: text/event-stream
string Fortschritt
data: {"batch_id":"11111111-1111-4111-8111-111111111111","status":"processing","total_records":10,"pending_records":5,"processing_records":1,"completed_records":4,"failed_records":0,"retryable_records":0,"result_records":4,"uncharged_records":0,"progress_percent":40.0,"estimated_completion_at":null,"eta_seconds_remaining":null}
GET /api/v1/salutation/batches/{id}/records/ Datensätze eines Auftrags abrufen
Datensätze in Upload-Reihenfolge, index ab 1. Folgen Sie next bis null. result ist vor Abschluss, bei einem Fehler oder ausstehender Zahlung null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid pagequery-
Seitennummer ab 1.
integer page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
1000Minimum:
1Maximum:
1000
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/salutation/batches/{id}/restart/ Fehlgeschlagene Datensätze erneut versuchen
Nur erneut versuchbare fehlgeschlagene Zeilen eines Auftrags mit Status cancelled, failed oder partially_completed starten. Bereits fertige Ergebnisse bleiben erhalten. Kein Anfragekörper erforderlich.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/salutation/batches/{id}/retry-billing/ Offene Ergebnisse eines Auftrags bezahlen
Offene Ergebnisse eines Auftrags nach einer Aufladung bezahlen. Voraussetzung: billing_paused=true. Reicht das Guthaben nur teilweise, bleibt billing_paused=true; bereits bezahlte Ergebnisse werden nicht erneut berechnet.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
410 Ergebnisse wurden nach Ablauf der Aufbewahrungsfrist gelöscht.
Inhaltstyp: application/json
POST /api/v1/salutation/batches/csv/ CSV-Auftrag starten
Eine CSV-Datei mit Kopfzeile hochladen: höchstens 100 MiB und 1.000.000 Datenzeilen. Trennzeichen Komma, Semikolon oder Tabulator werden erkannt. UTF-8 (mit/ohne BOM), Windows-1252 und Latin-1 werden unterstützt, UTF-16 nicht. Senden Sie Arrays als wiederholte Multipart-Felder; original_columns ist ein JSON-kodierter String. Limit: 10 Uploads/Minute. Jeder angenommene Upload erzeugt einen neuen Auftrag. Die Kopfzeile muss exakt first_name enthalten; salutation ist optional. Spaltennamen müssen eindeutig und nicht leer sein. Eigene Spalten bleiben erhalten. Die Kostenschätzung zählt nur Namen ohne vorhandene Anrede.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Anfrageinhalt · erforderlich
Inhaltstyp: multipart/form-data
Antworten
202
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
402 Guthaben reicht für die geschätzten Auftragskosten nicht aus.
Inhaltstyp: application/json
413 Die HTTP-Anfrage überschreitet das Größenlimit des Servers.
Inhaltstyp: application/json
GET /api/v1/salutation/batches/list/ Aufträge auflisten
Eigene Aufträge dieses Produkts, neueste zuerst. Die Auftragshistorie bleibt auch nach dem Löschen der Ergebnisse erhalten.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
cursorquery-
Undurchsichtiger Cursor. Folgen Sie der URL in next oder previous.
string page_sizequery-
Ergebnisse pro Seite, höchstens 1000.
integerStandard:
50Minimum:
1Maximum:
1000 via_apiquery-
Aufträge mit API-Schlüssel (true) oder aus der Konsole (false). Ohne Filter: beide.
boolean
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
400 Eingabe, Parameter oder Auftragsstatus erlauben diese Anfrage nicht.
Inhaltstyp: application/json
object Fehler mit detail/code oder Feldfehler als Listen bzw. verschachtelte Objekte, z. B. input_data.email.
Weitere Felder sind erlaubt.
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
POST /api/v1/salutation/batches/retry-billing/ Offene Ergebnisse dieses Produkts bezahlen
Bezahlt offene Ergebnisse dieses Produkts, älteste Aufträge zuerst, solange das Guthaben reicht. Aufladungen lösen dies auch automatisch aus. charged ist die Zahl der jetzt bezahlten Ergebnisse.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
GET /api/v1/salutation/records/{id}/ Ein Datensatzergebnis abrufen
Eingabe und Ergebnis eines eigenen Datensatzes dieses Produkts. Gelöschte Datensätze liefern 404. payment_pending zeigt eine ausstehende Zahlung an; result bleibt dann null.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
idpath Pflichtfeld-
stringuuid
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
Guthaben
Guthaben und Buchungsverlauf abrufen.
GET /api/v1/wallet/ Guthaben abrufen
Aktuelles Guthaben in Euro. balance ist ein Dezimalstring mit vier Nachkommastellen.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
GET /api/v1/wallet/transactions/ Buchungsverlauf abrufen
Neueste Buchungen zuerst, cursor-paginiert. Abbuchungen eines Auftrags werden zusammengefasst; charge_count zählt die zusammengefassten Ergebnisabbuchungen. Gutschriften stehen einzeln. Bei einer Sammelbuchung können record_id und subject null sein. Beträge haben vier Nachkommastellen.
API-Schlüssel erforderlich. Link zu diesem Aufruf
Parameter
cursorquery-
Undurchsichtiger Cursor. Folgen Sie der URL in next oder previous.
string page_sizequery-
Ergebnisse pro Seite, höchstens 500.
integerStandard:
50Minimum:
1Maximum:
500
Antworten
200
Inhaltstyp: application/json
403 API-Schlüssel fehlt, ist ungültig/deaktiviert oder das Konto ist gesperrt.
Inhaltstyp: application/json
429 Anfragelimit erreicht. Warten Sie vor dem nächsten Versuch.
Inhaltstyp: application/json
500 Interner Fehler.
Inhaltstyp: application/json
503 API vorübergehend nicht verfügbar.
Inhaltstyp: application/json
404 Nicht gefunden, falsches Produkt oder ungültige Seite.
Inhaltstyp: application/json
Keine passenden API-Aufrufe gefunden. Versuchen Sie einen anderen Suchbegriff.
Datenschemas
Verweise in den Anfragen und Antworten führen zu den folgenden wiederverwendeten Schemas. Öffnen Sie ein Schema, um Feldtypen, Pflichtfelder und zulässige Werte nachzuschlagen.
AcceptedLookup
object batch_idPflichtfeld-
stringuuid record_idPflichtfeld-
stringuuid statusPflichtfeld-
string* `validating` - Validating * `queued` - Queued * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed * `cancelled` - Cancelled
Zulässige Werte:
"validating","queued","processing","completed","partially_completed","failed","cancelled"
Address
object street-
Standard:
nullMindestens eine Variantestringnull house_number-
Standard:
nullMindestens eine Variantestringnull postal_code-
Standard:
nullMindestens eine Variantestringnull city-
Standard:
nullMindestens eine Variantestringnull country-
Standard:
nullMindestens eine Variantestringnull
BasicInfo
object company_name-
Standard:
nullMindestens eine Variantestringnull legal_formpurpose-
Standard:
nullMindestens eine Variantestringnull industries-
arrayEinträgestring headquarters-
Standard:
nullMindestens eine Variantestringnull founding_date-
Standard:
nullMindestens eine Variantestringnull
BatchPage
object nextPflichtfeld-
string | nulluri previousPflichtfeld-
string | nulluri resultsPflichtfeld-
arrayEinträge
CSVBalanceError
object detailPflichtfeld-
string code-
string balance_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] estimated_cost_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] topup_required_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ]
CommercialRegister
object court-
Standard:
nullMindestens eine Variantestringnull register_type-
Standard:
nullMindestens eine Variantestringnull register_number-
Standard:
nullMindestens eine Variantestringnull dates
ContactInfo
object addressphone_numbers-
arrayEinträge fax_numbers-
arrayEinträge email_addresses-
arrayEinträge websocial_media
CustomerBatch
object Status, Fortschritt und Abrechnung eines Auftrags.
idPflichtfeld-
stringuuid nur Antwort statusPflichtfeld-
stringnur Antwort* `validating` - Validating * `queued` - Queued * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed * `cancelled` - Cancelled
Zulässige Werte:
"validating","queued","processing","completed","partially_completed","failed","cancelled" priorityPflichtfeld-
integernur Antwort* `1` - 1 * `5` - 5 * `10` - 10
Zulässige Werte:
1,5,10 productPflichtfeld-
stringnur Antwort via_apiPflichtfeld-
booleannur Antwort total_recordsPflichtfeld-
integernur Antwort pending_recordsPflichtfeld-
integernur Antwort processing_recordsPflichtfeld-
integernur Antwort completed_recordsPflichtfeld-
integernur Antwort failed_recordsPflichtfeld-
integernur Antwort retryable_recordsPflichtfeld-
integernur Antwort result_recordsPflichtfeld-
integernur Antwort progress_percentPflichtfeld-
numberdouble nur Antwort estimated_creditsPflichtfeld-
stringnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] actual_creditsPflichtfeld-
stringnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] billing_pausedPflichtfeld-
booleannur Antwort uncharged_recordsPflichtfeld-
integernur Antwort scrapers_requestedPflichtfeld-
arraynur AntwortEinträgestring input_filenamePflichtfeld-
string | nullnur Antwort created_atPflichtfeld-
stringdate-time nur Antwort started_atPflichtfeld-
string | nulldate-time nur Antwort completed_atPflichtfeld-
string | nulldate-time nur Antwort estimated_completion_atPflichtfeld-
string | nulldate-time nur Antwort eta_seconds_remainingPflichtfeld-
integer | nullnur Antwort results_purged_atPflichtfeld-
string | nulldate-time nur Antwort
CustomerEmailVerificationRecord
object Ein Datensatz mit seiner Eingabe und dem Ergebnis des Produkts.
idPflichtfeld-
stringuuid nur Antwort indexPflichtfeld-
integernur AntwortPosition im Auftrag, ab 1, in Upload-Reihenfolge.
Minimum:
1 statusPflichtfeld-
stringnur Antwort* `pending` - Pending * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed
Zulässige Werte:
"pending","processing","completed","partially_completed","failed" input_dataPflichtfeld-
objectnur AntwortWeitere Felder resultPflichtfeld- nur Antwort
Ergebnis in der Form des Produkts. Null, solange die Verarbeitung nicht abgeschlossen ist, bei einem Fehler oder ausstehender Zahlung.
Genau eine Variantenull errorPflichtfeld-
string | nullnur AntwortWhy there is no result, or not all of it: the "Zeilen ohne Ergebnis" file's words.
chargedPflichtfeld-
booleannur Antwort charge_amountPflichtfeld-
string | nullnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] payment_pendingPflichtfeld-
booleannur Antwort
CustomerImprintRecord
object Ein Datensatz mit seiner Eingabe und dem Ergebnis des Produkts.
idPflichtfeld-
stringuuid nur Antwort indexPflichtfeld-
integernur AntwortPosition im Auftrag, ab 1, in Upload-Reihenfolge.
Minimum:
1 statusPflichtfeld-
stringnur Antwort* `pending` - Pending * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed
Zulässige Werte:
"pending","processing","completed","partially_completed","failed" input_dataPflichtfeld-
objectnur AntwortWeitere Felder resultPflichtfeld- nur Antwort
Ergebnis in der Form des Produkts. Null, solange die Verarbeitung nicht abgeschlossen ist, bei einem Fehler oder ausstehender Zahlung.
Genau eine Variantenull errorPflichtfeld-
string | nullnur AntwortWhy there is no result, or not all of it: the "Zeilen ohne Ergebnis" file's words.
chargedPflichtfeld-
booleannur Antwort charge_amountPflichtfeld-
string | nullnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] payment_pendingPflichtfeld-
booleannur Antwort
CustomerNormalizedEnrichmentRecord
object Ein Datensatz mit seiner Eingabe und dem Ergebnis des Produkts.
idPflichtfeld-
stringuuid nur Antwort indexPflichtfeld-
integernur AntwortPosition im Auftrag, ab 1, in Upload-Reihenfolge.
Minimum:
1 statusPflichtfeld-
stringnur Antwort* `pending` - Pending * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed
Zulässige Werte:
"pending","processing","completed","partially_completed","failed" input_dataPflichtfeld-
objectnur AntwortWeitere Felder resultPflichtfeld- nur Antwort
Ergebnis in der Form des Produkts. Null, solange die Verarbeitung nicht abgeschlossen ist, bei einem Fehler oder ausstehender Zahlung.
Genau eine Variantenull errorPflichtfeld-
string | nullnur AntwortWhy there is no result, or not all of it: the "Zeilen ohne Ergebnis" file's words.
chargedPflichtfeld-
booleannur Antwort charge_amountPflichtfeld-
string | nullnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] payment_pendingPflichtfeld-
booleannur Antwort
CustomerSalutationRecord
object Ein Datensatz mit seiner Eingabe und dem Ergebnis des Produkts.
idPflichtfeld-
stringuuid nur Antwort indexPflichtfeld-
integernur AntwortPosition im Auftrag, ab 1, in Upload-Reihenfolge.
Minimum:
1 statusPflichtfeld-
stringnur Antwort* `pending` - Pending * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed
Zulässige Werte:
"pending","processing","completed","partially_completed","failed" input_dataPflichtfeld-
objectnur AntwortWeitere Felder resultPflichtfeld- nur Antwort
Ergebnis in der Form des Produkts. Null, solange die Verarbeitung nicht abgeschlossen ist, bei einem Fehler oder ausstehender Zahlung.
Genau eine Variantenull errorPflichtfeld-
string | nullnur AntwortWhy there is no result, or not all of it: the "Zeilen ohne Ergebnis" file's words.
chargedPflichtfeld-
booleannur Antwort charge_amountPflichtfeld-
string | nullnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] payment_pendingPflichtfeld-
booleannur Antwort
CustomerTransaction
object Einzelne Gutschrift oder zusammengefasste Abbuchungen eines Auftrags.
idPflichtfeld-
stringuuid nur Antwort typePflichtfeld-
stringnur Antwort* `topup` - Top-up * `enrichment` - Enrichment charge * `scraper` - Scraper charge * `registry` - Company registry purchase * `refund` - Refund * `bonus` - Bonus
Zulässige Werte:
"topup","enrichment","scraper","registry","refund","bonus" amountPflichtfeld-
stringnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] balance_afterPflichtfeld-
stringnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] labelPflichtfeld-
stringnur AntwortWhat the transaction was, in German: the product for a charge (e.g. "Anreicherung"), otherwise the kind of credit.
detailsPflichtfeld-
stringnur AntwortWhich job and record a charge was for, in German, with the job's reference as the Jobs list shows it (e.g. "liste.csv · muster.de · Job #3E4BB20688"). A refund names its charge's; other credits leave it empty.
job_referencePflichtfeld-
string | nullnur AntwortThe job's reference as the console's Jobs list shows it, or null.
job_namePflichtfeld-
string | nullnur AntwortThe uploaded file's name, or null for a single lookup.
subjectPflichtfeld-
string | nullnur AntwortWhat the charged record was looked up by (domain, company name, email or register entry). Null once the record is deleted after the retention period.
batch_idPflichtfeld-
string | nulluuid nur AntwortUUID of the batch that triggered this transaction, if any.
record_idPflichtfeld-
string | nulluuid nur AntwortUUID of the enrichment record charged, if any.
refunded_charge_idPflichtfeld-
string | nulluuid nur AntwortFor a refund, the id of the charge it gives back; otherwise null.
created_atPflichtfeld-
stringdate-time nur Antwort charge_countPflichtfeld-
integernur Antwort
CustomerWallet
object Aktuelles Guthaben des Kontos.
balancePflichtfeld-
stringnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] created_atPflichtfeld-
stringdate-time nur Antwort
DecisionMakerContact
object emails-
arrayEinträge
DecisionMakerInfo
object decision_makers-
arrayEinträgeMindestens eine Variante
DetailError
object detailPflichtfeld-
string code-
string
EmailAddress
object addressPflichtfeld-
string status-
Standard:
nullMindestens eine Variantestringnull reason-
Standard:
nullMindestens eine Variantestringnull flags-
arrayEinträgestring is_disposable-
Standard:
nullMindestens eine Variantebooleannull
EmailVerificationAcceptedCSV
object batch_idPflichtfeld-
stringuuid record_countPflichtfeld-
integerMinimum:
1Maximum:
1000000 estimated_cost_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ]
EmailVerificationCSVRequest
object CSV-Datei und optionale Einstellungen für den Auftrag.
filePflichtfeld-
stringbinaryCSV file with records, separated by commas, semicolons or tabs (auto-detected). Max 100 MiB, max 1,000,000 rows.
product-
string* `email_verification` - email_verification
Zulässige Werte:
"email_verification" scrapers_requested-
arrayOptional explicit list of scrapers to invoke. Defaults to product scrapers.
EinträgestringMindestlänge:
1 overwrite_existing-
booleanIf true, re-enrich records that already have results.
Standard:
false export_columns-
arrayWird bei diesem Produkt ignoriert; der Export enthält alle Felder.
EinträgestringMindestlänge:
1 original_columns-
stringOptional JSON list: the file's own name for each column of the header row, where the uploader renamed columns to field names (the console does). The "Zeilen ohne Ergebnis" file names its columns so.
Mindestlänge:
1
EmailVerificationLookupRequest
object Eingabe einer Einzelabfrage. Das Produkt wird durch die URL bestimmt.
input_dataPflichtfeld-
objectEine E-Mail-Adresse prüfen. Syntax-, Domain- und DNS-Prüfung ohne SMTP-Test. Eigene Referenzfelder sind möglich. Werte sind Text, Zahlen (werden in Text umgewandelt) oder null. Keine Wahrheitswerte, Objekte oder Listen. Höchstens 50 Schlüssel mit je 1-100 Zeichen, Werte bis 1.000 Zeichen. NUL-Zeichen und ungültiges Unicode werden abgelehnt. Eingabefelder: https://krake.run/docs/input-columns.
Mindestens Felder:
1Höchstens Felder:
50emailPflichtfeld-
string | number | nullGenau eine E-Mail-Adresse; mehrere Adressen als CSV einreichen.
Höchstlänge:
1000
Weitere Felderstring | number | nullHöchstlänge:
1000Beispielwerte
[ { "email": "info@beispielbusiness.de" } ] product-
string* `email_verification` - email_verification
Zulässige Werte:
"email_verification"
EmailVerificationRecordPage
object nextPflichtfeld-
string | nulluri previousPflichtfeld-
string | nulluri resultsPflichtfeld-
arrayEinträge countPflichtfeld-
integerMinimum:
0
EmailVerificationResult
object emailPflichtfeld-
string statusPflichtfeld-
string | null* `undeliverable` - undeliverable * `accepts_mail` - accepts_mail * `risky` - risky * `unknown` - unknown
Zulässige Werte:
"undeliverable","accepts_mail","risky","unknown",null reasonPflichtfeld-
string | null flagsPflichtfeld-
arrayEinträgestring local_partPflichtfeld-
string | null domain_partPflichtfeld-
string | null ascii_domain_partPflichtfeld-
string | null mx_familyPflichtfeld-
string | null syntax_failure_indexPflichtfeld-
integer | null is_disposablePflichtfeld-
boolean | null
EmailVerificationSingleResult
object Ergebnis einer Einzelabfrage mit der Kennung ihres Auftrags.
batch_idPflichtfeld-
stringuuid nur Antwort idPflichtfeld-
stringuuid nur Antwort indexPflichtfeld-
integernur AntwortPosition im Auftrag, ab 1, in Upload-Reihenfolge.
Minimum:
1 statusPflichtfeld-
stringnur Antwort* `pending` - Pending * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed
Zulässige Werte:
"pending","processing","completed","partially_completed","failed" input_dataPflichtfeld-
objectnur AntwortWeitere Felder resultPflichtfeld- nur Antwort
Ergebnis in der Form des Produkts. Null, solange die Verarbeitung nicht abgeschlossen ist, bei einem Fehler oder ausstehender Zahlung.
Genau eine Variantenull errorPflichtfeld-
string | nullnur AntwortWhy there is no result, or not all of it: the "Zeilen ohne Ergebnis" file's words.
chargedPflichtfeld-
booleannur Antwort charge_amountPflichtfeld-
string | nullnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] payment_pendingPflichtfeld-
booleannur Antwort
EnrichmentAcceptedCSV
object batch_idPflichtfeld-
stringuuid record_countPflichtfeld-
integerMinimum:
1Maximum:
50000 estimated_cost_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ]
EnrichmentCSVRequest
object CSV-Datei und optionale Einstellungen für den Auftrag.
filePflichtfeld-
stringbinaryCSV file with records, separated by commas, semicolons or tabs (auto-detected). Max 10 MiB, max 50,000 rows.
product-
string* `enrichment` - enrichment
Zulässige Werte:
"enrichment" scrapers_requested-
arrayOptional explicit list of scrapers to invoke. Defaults to product scrapers.
EinträgestringMindestlänge:
1 overwrite_existing-
booleanIf true, re-enrich records that already have results.
Standard:
false export_columns-
arrayOptional list of enriched columns to include in the export. Empty = all.
EinträgestringMindestlänge:
1 original_columns-
stringOptional JSON list: the file's own name for each column of the header row, where the uploader renamed columns to field names (the console does). The "Zeilen ohne Ergebnis" file names its columns so.
Mindestlänge:
1
EnrichmentLookupRequest
object Eingabe einer Einzelabfrage. Das Produkt wird durch die URL bestimmt.
input_dataPflichtfeld-
objectGeben Sie company_domain, company_name + address_city, company_name + register_number oder register_number + register_court an. E-Mail-Adressen werden als Eingabe nicht angenommen, auch nicht unter Schreibweisen wie emailadresse, emailaddress oder mailadresse. Eigene Referenzfelder sind möglich. Werte sind Text, Zahlen (werden in Text umgewandelt) oder null. Keine Wahrheitswerte, Objekte oder Listen. Höchstens 50 Schlüssel mit je 1-100 Zeichen, Werte bis 1.000 Zeichen. NUL-Zeichen und ungültiges Unicode werden abgelehnt. Eingabefelder: https://krake.run/docs/input-columns.
Mindestens Felder:
1Höchstens Felder:
50Mindestens eine Varianteaddress_city-
string | number | nullHöchstlänge:
1000 address_house_number-
string | number | nullHöchstlänge:
1000 address_postal_code-
string | number | nullHöchstlänge:
1000 address_street-
string | number | nullHöchstlänge:
1000 company_domain-
string | number | nullDomain oder URL mit einem Domainnamen, z. B. beispielbusiness.de. Keine IP-Adresse.
Höchstlänge:
1000 company_name-
string | number | nullHöchstlänge:
1000 fax-
string | number | nullHöchstlänge:
1000 industry-
string | number | nullHöchstlänge:
1000 legal_form-
string | number | nullHöchstlänge:
1000 phone-
string | number | nullHöchstlänge:
1000 register_court-
string | number | nullHöchstlänge:
1000 register_number-
string | number | nullHöchstlänge:
1000 register_type-
string | number | nullHöchstlänge:
1000 social_media-
string | number | nullHöchstlänge:
1000 vat_id-
string | number | nullHöchstlänge:
1000 domain-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 website-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 url-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 homepage-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 company_address_street-
string | number | nullAlias für address_street.
Höchstlänge:
1000 company_address_house_number-
string | number | nullAlias für address_house_number.
Höchstlänge:
1000 company_address_postal_code-
string | number | nullAlias für address_postal_code.
Höchstlänge:
1000 company_address_city-
string | number | nullAlias für address_city.
Höchstlänge:
1000
Weitere Felderstring | number | nullHöchstlänge:
1000Beispielwerte
[ { "company_domain": "beispielbusiness.de" } ] product-
string* `enrichment` - enrichment
Zulässige Werte:
"enrichment"
EnrichmentRecordPage
object nextPflichtfeld-
string | nulluri previousPflichtfeld-
string | nulluri resultsPflichtfeld-
arrayEinträge countPflichtfeld-
integerMinimum:
0
ExpiredResults
object detailPflichtfeld-
string codePflichtfeld-
string* `results_expired` - results_expired
Zulässige Werte:
"results_expired" purged_atPflichtfeld-
stringdate-time
FaxNumber
object numberPflichtfeld-
string is_preferred-
booleanStandard:
false
FreeEmailCheckLimitError
object detailPflichtfeld-
string limit-
stringip: das Tageslimit dieser IP-Adresse; global: das aller Aufrufer. Fehlt beim Minutenlimit. * `ip` - ip * `global` - global
Zulässige Werte:
"ip","global"
FreeEmailCheckRequest
object Input of the free E-Mail-Prüfung (POST email-verification/check/, no API key).
emailPflichtfeld-
stringExactly one address; check several with a CSV job and an API key.
Mindestlänge:
1Höchstlänge:
1000
FreeEmailCheckResult
object resultPflichtfeld
GroupCompany
object A company the result's company belongs to: its owner, or the head of its group.
namePflichtfeld-
string country-
Standard:
nullMindestens eine Variantestringnull
ImprintBasicInfo
object company_name-
Standard:
nullMindestens eine Variantestringnull legal_form
ImprintCommercialRegister
object court-
Standard:
nullMindestens eine Variantestringnull register_type-
Standard:
nullMindestens eine Variantestringnull register_number-
Standard:
nullMindestens eine Variantestringnull
ImprintCompany
object type-
stringFester Wert:
"legal_entity"Standard:
"legal_entity" entity_name-
Standard:
nullMindestens eine Variantestringnull legal_formrole-
Standard:
nullMindestens eine Variantestringnull
ImprintContactInfo
object addressphone_numbers-
arrayEinträge fax_numbers-
arrayEinträge email_addresses-
arrayEinträge websocial_media
ImprintDecisionMakerInfo
object decision_makers-
arrayEinträgeGenau eine Variante
ImprintEmailAddress
object addressPflichtfeld-
string
ImprintLegalInfo
object commercial_registertax_info
ImprintPerson
object type-
stringFester Wert:
"natural_person"Standard:
"natural_person" role-
Standard:
nullMindestens eine Variantestringnull salutation-
Standard:
nullMindestens eine Variantestringnull title-
Standard:
nullMindestens eine Variantestringnull first_name-
Standard:
nullMindestens eine Variantestringnull last_name-
Standard:
nullMindestens eine Variantestringnull full_name-
Standard:
nullMindestens eine Variantestringnull contact
ImprintPersonContact
object emails-
arrayEinträge
ImprintResult
object basic_infolegal_infocontact_infodecision_maker_info
ImprintScraperAcceptedCSV
object batch_idPflichtfeld-
stringuuid record_countPflichtfeld-
integerMinimum:
1Maximum:
50000 estimated_cost_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ]
ImprintScraperCSVRequest
object CSV-Datei und optionale Einstellungen für den Auftrag.
filePflichtfeld-
stringbinaryCSV file with records, separated by commas, semicolons or tabs (auto-detected). Max 10 MiB, max 50,000 rows.
product-
string* `imprint_scraper` - imprint_scraper
Zulässige Werte:
"imprint_scraper" scrapers_requested-
arrayOptional explicit list of scrapers to invoke. Defaults to product scrapers.
EinträgestringMindestlänge:
1 overwrite_existing-
booleanIf true, re-enrich records that already have results.
Standard:
false export_columns-
arrayWird bei diesem Produkt ignoriert; der Export enthält alle Felder.
EinträgestringMindestlänge:
1 original_columns-
stringOptional JSON list: the file's own name for each column of the header row, where the uploader renamed columns to field names (the console does). The "Zeilen ohne Ergebnis" file names its columns so.
Mindestlänge:
1
ImprintScraperLookupRequest
object Eingabe einer Einzelabfrage. Das Produkt wird durch die URL bestimmt.
input_dataPflichtfeld-
objectGeben Sie eine company_domain an. Eigene Referenzfelder sind möglich. Werte sind Text, Zahlen (werden in Text umgewandelt) oder null. Keine Wahrheitswerte, Objekte oder Listen. Höchstens 50 Schlüssel mit je 1-100 Zeichen, Werte bis 1.000 Zeichen. NUL-Zeichen und ungültiges Unicode werden abgelehnt. Eingabefelder: https://krake.run/docs/input-columns.
Mindestens Felder:
1Höchstens Felder:
50Mindestens eine Varianteaddress_city-
string | number | nullHöchstlänge:
1000 address_house_number-
string | number | nullHöchstlänge:
1000 address_postal_code-
string | number | nullHöchstlänge:
1000 address_street-
string | number | nullHöchstlänge:
1000 company_domain-
string | number | nullDomain oder URL mit einem Domainnamen, z. B. beispielbusiness.de. Keine IP-Adresse.
Höchstlänge:
1000 company_name-
string | number | nullHöchstlänge:
1000 email-
string | number | nullHöchstlänge:
1000 fax-
string | number | nullHöchstlänge:
1000 industry-
string | number | nullHöchstlänge:
1000 legal_form-
string | number | nullHöchstlänge:
1000 phone-
string | number | nullHöchstlänge:
1000 register_court-
string | number | nullHöchstlänge:
1000 register_number-
string | number | nullHöchstlänge:
1000 register_type-
string | number | nullHöchstlänge:
1000 social_media-
string | number | nullHöchstlänge:
1000 vat_id-
string | number | nullHöchstlänge:
1000 domain-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 website-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 url-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 homepage-
string | number | nullAlias für company_domain.
Höchstlänge:
1000 company_address_street-
string | number | nullAlias für address_street.
Höchstlänge:
1000 company_address_house_number-
string | number | nullAlias für address_house_number.
Höchstlänge:
1000 company_address_postal_code-
string | number | nullAlias für address_postal_code.
Höchstlänge:
1000 company_address_city-
string | number | nullAlias für address_city.
Höchstlänge:
1000
Weitere Felderstring | number | nullHöchstlänge:
1000Beispielwerte
[ { "company_domain": "beispielbusiness.de" } ] product-
string* `imprint_scraper` - imprint_scraper
Zulässige Werte:
"imprint_scraper"
ImprintScraperRecordPage
object nextPflichtfeld-
string | nulluri previousPflichtfeld-
string | nulluri resultsPflichtfeld-
arrayEinträge countPflichtfeld-
integerMinimum:
0
LegalEntityDecisionMaker
object A company in a role, such as the GmbH behind a GmbH & Co. KG. Who represents it is on its own register sheet, which would take a second register lookup, so it is not here.
type-
stringStandard:
"legal_entity" entity_name-
Standard:
nullMindestens eine Variantestringnull legal_formrole-
Standard:
nullMindestens eine Variantestringnull seat-
Standard:
nullMindestens eine Variantestringnull commercial_register
LegalForm
object full-
Standard:
nullMindestens eine Variantestringnull short-
Standard:
nullMindestens eine Variantestringnull
LegalInfo
object commercial_registertax_infoshare_capitalparent_companyultimate_parent_company
NaturalPersonDecisionMaker
object type-
stringStandard:
"natural_person" role-
Standard:
nullMindestens eine Variantestringnull salutation-
Standard:
nullMindestens eine Variantestringnull title-
Standard:
nullMindestens eine Variantestringnull first_name-
Standard:
nullMindestens eine Variantestringnull last_name-
Standard:
nullMindestens eine Variantestringnull full_name-
Standard:
nullMindestens eine Variantestringnull location-
Standard:
nullMindestens eine Variantestringnull birth_date-
Standard:
nullMindestens eine Variantestringnull contact
NormalizedResult
object Structured normalized output for a single enrichment result.
basic_infolegal_infocontact_infodecision_maker_info
PartnerRegister
object court-
Standard:
nullMindestens eine Variantestringnull register_type-
Standard:
nullMindestens eine Variantestringnull register_number-
Standard:
nullMindestens eine Variantestringnull
PhoneNumber
object numberPflichtfeld-
string is_preferred-
booleanStandard:
false
RegisterDates
object first_registered-
Standard:
nullMindestens eine Variantestringnull last_modified-
Standard:
nullMindestens eine Variantestringnull last_entry-
Standard:
nullMindestens eine Variantestringnull
RetryBilling
object chargedPflichtfeld-
integerMinimum:
0 failedPflichtfeld-
integerMinimum:
0 total_charged_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] billing_pausedPflichtfeld-
boolean
SalutationAcceptedCSV
object batch_idPflichtfeld-
stringuuid record_countPflichtfeld-
integerMinimum:
1Maximum:
1000000 estimated_cost_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ]
SalutationCSVRequest
object CSV-Datei und optionale Einstellungen für den Auftrag.
filePflichtfeld-
stringbinaryCSV file with records, separated by commas, semicolons or tabs (auto-detected). Max 100 MiB, max 1,000,000 rows.
product-
string* `salutation` - salutation
Zulässige Werte:
"salutation" scrapers_requested-
arrayDieses lokale Tool akzeptiert keine Scraper-Auswahl.
Höchstens Einträge:
0EinträgestringMindestlänge:
1 overwrite_existing-
booleanIf true, re-enrich records that already have results.
Standard:
false export_columns-
arrayWird bei diesem Produkt ignoriert; der Export enthält alle Felder.
EinträgestringMindestlänge:
1 original_columns-
stringOptional JSON list: the file's own name for each column of the header row, where the uploader renamed columns to field names (the console does). The "Zeilen ohne Ergebnis" file names its columns so.
Mindestlänge:
1
SalutationLookupRequest
object Eingabe einer Einzelabfrage. Das Produkt wird durch die URL bestimmt.
input_dataPflichtfeld-
objectGeben Sie first_name oder eine vorhandene salutation an. Schreibweisen der Schlüssel müssen exakt stimmen. Vorhandene Werte und Leerzeichen bleiben erhalten. Nur eine neu zugewiesene Anrede wird berechnet. Bei unbekannten oder mehrdeutigen Vornamen wird keine Anrede geschätzt. Eigene Referenzfelder sind möglich. Werte sind Text, Zahlen (werden in Text umgewandelt) oder null. Keine Wahrheitswerte, Objekte oder Listen. Höchstens 50 Schlüssel mit je 1-100 Zeichen, Werte bis 1.000 Zeichen. NUL-Zeichen und ungültiges Unicode werden abgelehnt. Eingabefelder: https://krake.run/docs/input-columns.
Mindestens Felder:
1Höchstens Felder:
50Mindestens eine Variantefirst_name-
string | number | nullVorname für eine fehlende Anrede.
Höchstlänge:
1000 salutation-
string | number | nullVorhandene Anrede. Wird unverändert übernommen und nicht berechnet.
Höchstlänge:
1000
Weitere Felderstring | number | nullHöchstlänge:
1000Beispielwerte
[ { "first_name": "Max" } ] product-
string* `salutation` - salutation
Zulässige Werte:
"salutation"
SalutationRecordPage
object nextPflichtfeld-
string | nulluri previousPflichtfeld-
string | nulluri resultsPflichtfeld-
arrayEinträge countPflichtfeld-
integerMinimum:
0
SalutationResult
object salutationPflichtfeld- Mindestens eine Variante
stringnull salutation_statusPflichtfeld-
stringZulässige Werte:
"assigned","existing","ambiguous","unknown","no_first_name"
SalutationSingleResult
object Ergebnis einer Einzelabfrage mit der Kennung ihres Auftrags.
batch_idPflichtfeld-
stringuuid nur Antwort idPflichtfeld-
stringuuid nur Antwort indexPflichtfeld-
integernur AntwortPosition im Auftrag, ab 1, in Upload-Reihenfolge.
Minimum:
1 statusPflichtfeld-
stringnur Antwort* `pending` - Pending * `processing` - Processing * `completed` - Completed * `partially_completed` - Partially completed * `failed` - Failed
Zulässige Werte:
"pending","processing","completed","partially_completed","failed" input_dataPflichtfeld-
objectnur AntwortWeitere Felder resultPflichtfeld- nur Antwort
Ergebnis in der Form des Produkts. Null, solange die Verarbeitung nicht abgeschlossen ist, bei einem Fehler oder ausstehender Zahlung.
Genau eine Variantenull errorPflichtfeld-
string | nullnur AntwortWhy there is no result, or not all of it: the "Zeilen ohne Ergebnis" file's words.
chargedPflichtfeld-
booleannur Antwort charge_amountPflichtfeld-
string | nullnur AntwortEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] payment_pendingPflichtfeld-
booleannur Antwort
SettledResults
object chargedPflichtfeld-
integerMinimum:
0
ShareCapital
object amount-
Standard:
nullMindestens eine Variantenumbernull currency-
stringStandard:
"EUR"
SingleBalanceError
object detailPflichtfeld-
string code-
string balance_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ] required_eurPflichtfeld-
stringEurobetrag als Dezimalstring mit vier Nachkommastellen.
Muster:
"^-?\\d+\\.\\d{4}$"Beispielwerte
[ "0.0006" ]
SocialLink
object platformPflichtfeld-
string urlPflichtfeld-
string
SocialMedia
object linkedin-
Standard:
nullMindestens eine Variantestringnull xing-
Standard:
nullMindestens eine Variantestringnull facebook-
Standard:
nullMindestens eine Variantestringnull twitter-
Standard:
nullMindestens eine Variantestringnull instagram-
Standard:
nullMindestens eine Variantestringnull youtube-
Standard:
nullMindestens eine Variantestringnull other-
arrayEinträge
TaxInfo
object vat_id-
Standard:
nullMindestens eine Variantestringnull
TransactionPage
object nextPflichtfeld-
string | nulluri previousPflichtfeld-
string | nulluri resultsPflichtfeld-
arrayEinträge
WebInfo
object domain-
Standard:
nullMindestens eine Variantestringnull website-
Standard:
nullMindestens eine Variantestringnull imprint_url-
Standard:
nullMindestens eine Variantestringnull