Documentazione API CredoRisk.
Il cliente richiede un report tramite la tua API. Il tuo backend chiama quindi l API CredoRisk, che genera il report standardizzato e lo restituisce in JSON/PDF.
Avvio rapido
Collega CredoRisk al tuo backend in pochi giorni
L’API è pensata per un uso server-to-server: autenticazione tramite chiave, endpoint stabili, risposte JSON normalizzate. I team di business mantengono lo stesso formato CredoRisk dell’interfaccia web — senza esporre i provider sorgente al cliente finale.
- Chiavi API create e revocabili nello spazio cliente
- Flusso Francia consigliato: search → france/{siren} → uuid → PDF
- Internazionale: paese + identificativo ufficiale
- Errori documentati (401, 402, 422…) e timeout consigliati
Avvio rapido — Francia (consigliato)
Flusso Standard Report API: stessa logica dell interfaccia web CredoRisk. Salva l uuid restituito.
Per un SIRET a 14 cifre, usa le prime 9 cifre come SIREN. Timeout consigliato: 60-90 s.
Autenticazione
Ogni richiesta e firmata con una chiave API CredoRisk (header Authorization: Bearer o X-API-Key). Il cliente non vede mai il provider sorgente.
Prezzi API
L API e gratuita. La fatturazione si basa sui report generati, con sconti volume.
Vedi prezzi reportFormato report CredoRisk
Risposta standardizzata: company, decision, sections.directors, sections.financials, sections.signals. Contratto stabile indipendente dal provider sorgente.
Tracciabilita completa
Tutte le chiamate API sono tracciate. I report standard sono salvati per uuid; l API classica usa report_id.
Francia — Standard Report API
Ricerca per nome, generazione per SIREN, salva UUID, rileggi e scarica PDF.
1) Ricerca
GET /standard/search?q=... - leggi results.resultats[] e SIREN.
2) Generazione
GET /standard/france/{siren} - recupera report.uuid.
3) Rilettura
GET /standard/report/{uuid} - campi credorisk + raw.
4) PDF
GET /standard/report/{uuid}/pdf - download senza credito aggiuntivo.
Endpoint /standard/*
GET /api/v1/standard/search?q=...
Cerca in Francia per nome azienda. Risposta: results.resultats (lista aziende).
GET /api/v1/standard/france/{siren}
Genera o restituisce un report completo Francia. Risposta: report.uuid, cached.
GET /api/v1/standard/report/{uuid}
Rilettura con credorisk, raw, source_type.
GET /api/v1/standard/{country}/{identifier}
Report internazionale (fuori dalla Francia).
API classica (legacy)
Per la Francia, preferisci la Standard Report API sopra.
POST /api/v1/companies/search
Ricerca aziende per paese + criteri.
GET /api/v1/companies/{providerCompanyId}/report
Genera (o restituisce da cache) un report CredoRisk.
GET /api/v1/reports/{reportId}
Recupera un report salvato tramite identificativo.
GET /api/v1/account/credits
Restituisce saldo residuo e utilizzo API mensile.
Risposta di esempio report (formato CredoRisk)
Principali codici errore
- 401 — Chiave API mancante o non valida
- 402 — Crediti insufficienti per generare un report live
- 403 — Account non verificato
- 404 — Report non trovato
- 422 — Parametri non validi
- 429 — Quota API mensile raggiunta
- 500 — Errore interno
- 503 — Servizio ricerca/dati non configurato
Pronto a testare l API?
Crea un account, genera una chiave API CredoRisk e integra rapidamente la generazione report nel flusso cliente.