Разработчики

CredoRisk API документация.

Клиент запрашивает отчет через ваш API. Затем ваша серверная часть вызывает CredoRisk API, который генерирует стандартизированный отчет и возвращает его в JSON/PDF.

Быстрый старт

Интеграция

Подключите CredoRisk к бэкенду за несколько дней

API рассчитан на сервер-сервер: аутентификация по ключу, стабильные endpoints, нормализованный JSON. Бизнес-команды сохраняют тот же формат CredoRisk, что в веб-интерфейсе — без раскрытия исходных провайдеров конечному клиенту.

API-ключи создаются и отзываются в клиентском кабинете
Рекомендуемый поток Франция: search → france/{siren} → uuid → PDF
Международ: страна + официальный идентификатор
Документированные ошибки (401, 402, 422…) и рекомендуемые таймауты

Создать аккаунт разработчика

Краткое руководство — Франция (рекомендуется)

Стандартный отчет API: та же логика, что и в веб-интерфейсе CredoRisk. Сохраните возвращенный 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"
      

Для 14-значного SIRET используйте первые 9 цифр как SIREN. Рекомендуемый таймаут: 60-90 с.

Стандартный отчет API Классический API (устаревший) API цены

Аутентификация

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 цены

API бесплатен. Выставление счетов основано на созданных отчетах с учетом скидок за объем.

Посмотреть стоимость отчета

CredoRisk формат отчета

Стандартный ответ: company, decision, sections.directors, sections.financials, sections.signals. Стабильный контракт, независимый от исходного поставщика.

Полная отслеживаемость

Все звонки API отслеживаются. Стандартные отчеты хранятся в uuid; классический API использует report_id.

Рекомендуемый расход

Франция — Стандартный отчет API

Выполните поиск по имени, сгенерируйте SIREN, сохраните UUID, прочитайте и загрузите PDF.

1) Поиск

GET /standard/search?q=... — прочитайте results.resultats[] и SIREN.

2) Генерация

GET /standard/france/{siren} — получите report.uuid.

3) Повторное чтение

GET /standard/report/{uuid} — поля credoris + raw.

4) PDF

GET /standard/report/{uuid}/pdf — загрузка без дополнительной оплаты.

Стандартный отчет

Конечные точки /стандартные/*

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

Найдите Францию по названию компании. Ответ: results.resultats (список компаний).

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

Создайте или верните полный отчет по Франции. Ответ: report.uuid, кэшированный.

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

Повторное чтение с помощью credoris, raw, source_type.

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

Международный отчет (за пределами Франции).

Наследие

Классический API (устаревший)

Для Франции отдайте предпочтение Стандартному отчету API, указанному выше.

POST /api/v1/companies/search

Поиск компаний по стране + критериям.

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

Создайте (или верните в кэш) отчет CredoRisk.

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

GET /api/v1/reports/{reportId}

Получить сохраненный отчет по идентификатору.

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

GET /api/v1/account/credits

Возврат оставшегося баланса и ежемесячного использования API.

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

Пример ответа на отчет (формат 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": []
    }
  }
}
      

Основные коды ошибок

401 — Ключ API отсутствует или недействителен.
402 — Недостаточно кредитов для создания живого отчета
403 — Аккаунт не подтвержден
404 — Отчет не найден
422 — Неверные параметры
429 — Достигнута месячная квота API
500 — Внутренняя ошибка
503 — Служба поиска/данных не настроена

Готовы протестировать API?

Создайте учетную запись, сгенерируйте ключ CredoRisk API и быстро интегрируйте создание отчетов в рабочий процесс вашего клиента.

Зарегистрироваться Посмотреть цены