Developers

CredoRisk API documentation.

The customer requests a report through your API. Your backend then calls the CredoRisk API, which generates the standardized report and returns it in JSON/PDF.

Quickstart

Integration

Connect CredoRisk to your backend in a few days

The API is built for server-to-server use: key auth, stable endpoints, normalised JSON. Business teams keep the same CredoRisk format as in the web UI — without exposing source providers to the end customer.

API keys created and revocable in the client workspace
Recommended France flow: search → france/{siren} → uuid → PDF
International: country + official identifier
Documented errors (401, 402, 422…) and recommended timeouts

Create a developer account

Quickstart — France (recommended)

Standard Report API flow: same logic as the CredoRisk web interface. Store the returned uuid.

# 1) Search France by name (0 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/search?q=airbus"
# -> read results.resultats[].siren

# 2) Generate France report (1 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/france/383474814"
# -> store report.uuid

# 3) Full readback (0 credit)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000"

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

For a 14-digit SIRET, use the first 9 digits as SIREN. Recommended timeout: 60-90 s.

Standard Report API Classic API (legacy) API pricing

Authentication

Each request is signed with a CredoRisk API key (header Authorization: Bearer or X-API-Key). The client never sees the source provider.

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

API pricing

The API is free. Billing is based on generated reports, with volume discounts.

See report pricing

CredoRisk report format

Standardized response: company, decision, sections.directors, sections.financials, sections.signals. Stable contract independent from the source provider.

Full traceability

All API calls are tracked. Standard reports are stored by uuid; classic API uses report_id.

Recommended flow

France — Standard Report API

Search by name, generate by SIREN, store UUID, read back and download PDF.

1) Search

GET /standard/search?q=... - read results.resultats[] and SIREN.

2) Generation

GET /standard/france/{siren} - fetch report.uuid.

3) Readback

GET /standard/report/{uuid} - fields credorisk + raw.

4) PDF

GET /standard/report/{uuid}/pdf - download without extra credit.

Standard report

Endpoints /standard/*

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

Search France by company name. Response: results.resultats (company list).

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

Generate or return a full France report. Response: report.uuid, cached.

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

Readback with credorisk, raw, source_type.

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

International report (outside France).

Legacy

Classic API (legacy)

For France, prefer the Standard Report API above.

POST /api/v1/companies/search

Search companies by country + criteria.

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

Generate (or return cache) a CredoRisk report.

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

GET /api/v1/reports/{reportId}

Retrieve a stored report by identifier.

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

GET /api/v1/account/credits

Return remaining balance and monthly API usage.

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

Sample report response (CredoRisk format)

{
  "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": []
    }
  }
}
      

Main error codes

401 — Missing or invalid API key
402 — Insufficient credits to generate a live report
403 — Account not verified
404 — Report not found
422 — Invalid parameters
429 — Monthly API quota reached
500 — Internal error
503 — Search/data service not configured

Ready to test the API?

Create an account, generate a CredoRisk API key, and quickly integrate report generation in your customer workflow.

Create account View pricing