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 client (5 minutes)

Le plus simple pour vos clients API: 1 clé API CredoRisk, 3 appels HTTP, 1 report exploitable au format CredoRisk.

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

# 2) Génération / restitution du report CredoRisk
curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/companies/FR30612897/report?country=FR&language=fr"

# 3) Relecture d'un report enregistré (sans coût crédit)
curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/reports/1284"
      

Voir la documentation détaillée Voir tarification API Voir un rapport exemple

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 (endpoint, statut HTTP, durée, coût crédit). Les reports sont stockés en base pour restitution ultérieure via report_id.

Flux recommandé

Comment un client API récupère un report

Un flux simple entre votre client, votre API et CredoRisk.

1) Recherche entreprise

Votre backend appelle l’endpoint de recherche pour obtenir les sociétés candidates et l’identifiant société à interroger.

2) Demande report

Votre backend appelle l’endpoint report. CredoRisk construit le report, le stocke en base et renvoie report_id + report.

3) Relecture report

Le client peut relire le report via /api/v1/reports/{id} sans reconsommation de crédit.

Exemples

Endpoints API v1

Contrat client CredoRisk (JSON).

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://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://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://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://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

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