Développeurs

Documentation API CredoRisk.

Le client demande un report via votre API. Votre backend appelle ensuite l’API CredoRisk, qui génère le report standardisé et le restitue en JSON/PDF.

Quickstart

Quickstart — France (recommandé)

Parcours API Rapport standard : même logique que l’interface web CredoRisk. Stockez l’uuid renvoyé.

# 1) Recherche France par nom (0 crédit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://www.credorisk.com/api/v1/standard/search?q=airbus"
# → lire results.resultats[].siren

# 2) Génération rapport France (1 crédit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://www.credorisk.com/api/v1/standard/france/383474814"
# → stocker report.uuid

# 3) Relecture complète (0 crédit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://www.credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000"

# 4) PDF (0 crédit)
curl -sS -H "Authorization: Bearer <api_key>" \
  -o rapport.pdf \
  "https://www.credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000/pdf"
      

SIRET 14 chiffres : utilisez les 9 premiers chiffres comme SIREN. Timeout conseillé : 60–90 s.

API Rapport standard API classique (legacy) Tarification API

Authentification

Chaque appel est signé avec une clé API CredoRisk (header Authorization: Bearer ou X-API-Key). Le client ne voit jamais le provider source.

Authorization: Bearer <CREDORISK_API_KEY>
ou
X-API-Key: <CREDORISK_API_KEY>
          

Tarification API

API gratuite. La facturation se fait au report généré, avec remises par volume.

Voir les prix report

Format report CredoRisk

Réponse normalisée: company, decision, sections.directors, sections.financials, sections.signals. Contrat stable, indépendant du provider source.

Traçabilité complète

Tous les appels API sont tracés. Les rapports standard sont stockés par uuid ; l’API classique utilise report_id.

Flux recommandé

France — API Rapport standard

Recherche par nom, génération par SIREN, stockage UUID, relecture et PDF.

1) Recherche

GET /standard/search?q=... — lire results.resultats[] et le SIREN.

2) Génération

GET /standard/france/{siren} — récupérer report.uuid.

3) Relecture

GET /standard/report/{uuid} — champs credorisk + raw.

4) PDF

GET /standard/report/{uuid}/pdf — téléchargement sans crédit supplémentaire.

Rapport standard

Endpoints /standard/*

GET /api/v1/standard/search?q=...

Recherche France par nom. Réponse : results.resultats (tableau d’entreprises).

GET /api/v1/standard/france/{siren}

Génère ou restitue un rapport France complet. Réponse : report.uuid, cached.

GET /api/v1/standard/report/{uuid}

Relecture avec credorisk, raw, source_type.

GET /api/v1/standard/{country}/{identifier}

Rapport international (hors France).

Legacy

API classique (legacy)

Pour la France, préférez l’API Rapport standard ci-dessus.

POST /api/v1/companies/search

Recherche entreprises par pays + critères.

curl -X POST -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"countries":"FR","name":"LA REDOUTE","city":"ROUBAIX"}' \
  "https://www.credorisk.com/api/v1/companies/search"
          

GET /api/v1/companies/{providerCompanyId}/report

Génère (ou restitue cache) un report CredoRisk.

curl -H "Authorization: Bearer <api_key>" \
  "https://www.credorisk.com/api/v1/companies/FR30612897/report?country=FR&language=fr"
          

GET /api/v1/reports/{reportId}

Récupère un report déjà stocké par son identifiant.

curl -H "Authorization: Bearer <api_key>" \
  "https://www.credorisk.com/api/v1/reports/1284"
          

GET /api/v1/account/credits

Retourne le solde et la consommation API mensuelle.

curl -H "Authorization: Bearer <api_key>" \
  "https://www.credorisk.com/api/v1/account/credits"
          

Exemple de réponse report (format CredoRisk)

{
  "report_id": 1284,
  "credits_cost": 1,
  "source": "live",
  "report": {
    "company": {
      "name": "EXEMPLE SA",
      "country": "FR",
      "status": "Active",
      "reg_no": "123456789",
      "vat_no": "FR00123456789",
      "address": {
        "street": "10 RUE EXEMPLE",
        "city": "PARIS",
        "postcode": "75001",
        "region": "ILE-DE-FRANCE"
      }
    },
    "decision": {
      "score": 72,
      "risk_band": "B",
      "credit_limit": {
        "value": 50000,
        "currency": "EUR"
      },
      "days_beyond_terms": 8
    },
    "sections": {
      "directors": [],
      "financials": [],
      "signals": []
    }
  }
}
      

Codes d’erreur principaux

401 — Clé API manquante ou invalide
402 — Crédits insuffisants pour générer un report live
403 — Compte non vérifié
404 — Rapport introuvable
422 — Paramètres invalides
429 — Quota mensuel API atteint
500 — Erreur interne
503 — Service recherche / données non configuré

Prêt à tester l’API ?

Créez un compte, générez une clé API CredoRisk, et intégrez rapidement la génération de report dans votre parcours client.

Créer un compte Voir les tarifs