CredoRisk API-Dokumentation.
Der Kunde fordert über Ihre API einen Bericht an. Ihr Backend ruft dann die CredoRisk API auf, die den standardisierten Bericht erstellt und als JSON/PDF zurückliefert.
Schnellstart
CredoRisk in wenigen Tagen an Ihr Backend anbinden
Die API ist für Server-zu-Server-Nutzung ausgelegt: Key-Authentifizierung, stabile Endpunkte, normalisierte JSON-Antworten. Ihre Fachteams behalten dasselbe CredoRisk-Format wie in der Weboberfläche — ohne Quellanbieter dem Endkunden preiszugeben.
- API-Keys erstellbar und widerrufbar im Kundenbereich
- Empfohlener Frankreich-Flow: search → france/{siren} → uuid → PDF
- International: Land + offizielle Kennung
- Dokumentierte Fehler (401, 402, 422…) und empfohlene Timeouts
Schnellstart — Frankreich (empfohlen)
Ablauf der Standard-Berichts-API: gleiche Logik wie in der CredoRisk-Weboberfläche. Speichern Sie die zurückgegebene uuid.
Bei einer 14-stelligen SIRET verwenden Sie die ersten 9 Ziffern als SIREN. Empfohlenes Timeout: 60-90 s.
Authentifizierung
Jede Anfrage wird mit einem CredoRisk API-Key signiert (Header Authorization: Bearer oder X-API-Key). Der Kunde sieht niemals den Quellanbieter.
API-Preise
Die API ist kostenlos. Die Abrechnung basiert auf erzeugten Berichten mit Mengenrabatten.
Berichtspreise ansehenCredoRisk-Berichtsformat
Standardisierte Antwort: company, decision, sections.directors, sections.financials, sections.signals. Stabiler Vertrag unabhängig vom Quellanbieter.
Vollständige Nachverfolgbarkeit
Alle API-Aufrufe werden protokolliert. Standard-Berichte werden über uuid gespeichert; die klassische API verwendet report_id.
Frankreich — Standard-Berichts-API
Nach Namen suchen, über SIREN erzeugen, UUID speichern, erneut abrufen und PDF herunterladen.
1) Suche
GET /standard/search?q=... - results.resultats[] und SIREN auslesen.
2) Erzeugung
GET /standard/france/{siren} - report.uuid abrufen.
3) Abruf
GET /standard/report/{uuid} - Felder credorisk + raw.
4) PDF
GET /standard/report/{uuid}/pdf - Download ohne zusätzlichen Credit.
Endpunkte /standard/*
GET /api/v1/standard/search?q=...
Frankreich nach Unternehmensname suchen. Antwort: results.resultats (Unternehmensliste).
GET /api/v1/standard/france/{siren}
Vollständigen Frankreich-Bericht erzeugen oder aus Cache liefern. Antwort: report.uuid, cached.
GET /api/v1/standard/report/{uuid}
Abruf mit credorisk, raw, source_type.
GET /api/v1/standard/{country}/{identifier}
Internationaler Bericht (außerhalb Frankreichs).
Klassische API (Altbestand)
Für Frankreich bevorzugen Sie die obenstehende Standard-Berichts-API.
POST /api/v1/companies/search
Unternehmen nach Land + Kriterien suchen.
GET /api/v1/companies/{providerCompanyId}/report
Einen CredoRisk-Bericht erzeugen (oder aus Cache liefern).
GET /api/v1/reports/{reportId}
Einen gespeicherten Bericht per Kennung abrufen.
GET /api/v1/account/credits
Restguthaben und monatliche API-Nutzung zurückgeben.
Beispiel einer Berichtsantwort (CredoRisk-Format)
Wichtigste Fehlercodes
- 401 — Fehlender oder ungültiger API-Key
- 402 — Nicht genügend Credits zur Erzeugung eines Live-Berichts
- 403 — Konto nicht verifiziert
- 404 — Bericht nicht gefunden
- 422 — Ungültige Parameter
- 429 — Monatliches API-Kontingent erreicht
- 500 — Interner Fehler
- 503 — Such-/Datendienst nicht konfiguriert
Bereit, die API zu testen?
Erstellen Sie ein Konto, generieren Sie einen CredoRisk API-Key und integrieren Sie die Berichterstellung schnell in Ihren Kundenablauf.