Программный интерфейс

Один контракт на все модули: реестр, вызов, задача, результат. Формат ответа не зависит от того, обращается к платформе человек, ваша система или ИИ-агент.

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

Ключ организации в заголовке

Каждый запрос несёт заголовок X-API-Key. Ключ выдаётся организации, к нему привязаны баланс, лимиты и журнал действий. Сервисные ключи сотрудников и клиентские ключи разделены: списание идёт только по клиентским.

Базовый адрес: https://api.inforensic.pro/v2

Проверка доступа

curl https://api.inforensic.pro/v2/health
curl https://api.inforensic.pro/v2/modules -H "X-API-Key: $CONTEXT_KEY"
Адреса

Семь адресов на всю платформу

Реестр модулей отдаёт схемы входа и цену, поэтому клиент может строить запрос без ручной сверки с документацией.

  • Эндпоинт GET /v2/modules
    Назначение Реестр модулей со схемами входа и ценой
    Списание бесплатно
  • Эндпоинт GET /v2/modules/{key}
    Назначение Паспорт одного модуля
    Списание бесплатно
  • Эндпоинт POST /v2/modules/{key}/execute
    Назначение Синхронный вызов, ответ в том же запросе
    Списание по тарифу модуля
  • Эндпоинт POST /v2/modules/{key}/execute_async
    Назначение Постановка задачи, возвращает task_id
    Списание по тарифу модуля
  • Эндпоинт GET /v2/task/{task_id}/status
    Назначение Статус задачи и прогресс
    Списание бесплатно
  • Эндпоинт GET /v2/task/{task_id}/result
    Назначение Результат завершённой задачи
    Списание бесплатно
  • Эндпоинт GET /v2/health
    Назначение Состояние сервиса
    Списание бесплатно
  • Эндпоинт POST /v2/open-banking/v1.0/checks/{key}
    Назначение Та же проверка в формате Открытых API Банка России
    Списание по тарифу модуля
  • Эндпоинт GET /v2/open-banking/v1.0/openapi.yaml
    Назначение Спецификация OpenAPI 3.0 формата ЦБ
    Списание бесплатно
Вызов

Синхронно или задачей

Быстрые модули

# Синхронный вызов: ответ приходит в том же запросе
curl -X POST \
  https://api.inforensic.pro/v2/modules/\
  compliance.fns_disqualified/execute \
  -H "X-API-Key: $CONTEXT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"last_name":"Петрова","first_name":"Елена","birth_date":"1978-03-12"}'

Долгие источники

# Асинхронный вызов: задача и опрос статуса
curl -X POST .../execute_async -H "X-API-Key: $CONTEXT_KEY" -d '{...}'
→ {"task_id":"550e8400-e29b-41d4-a716-446655440000"}

curl .../v2/task/$TASK_ID/status  # PENDING → PROGRESS → COMPLETED
curl .../v2/task/$TASK_ID/result

Синхронный вызов удобен для локальных и быстрых проверок. Источники с браузерным обходом и капчей отвечают дольше, для них предусмотрена задача с опросом статуса или вебхуком.

Ответ

Единый конверт

Структура ответа

{
  "status": "COMPLETED",
  "success": true,
  "module_name": "fns_disqualified",
  "data": {
    "found": true, "total_count": 1,
    "results": [ /* записи источника */ ],
    "risk_profile": { /* уровни и факторы */ },
    "source": "service.nalog.ru",
    "data_actual_date": "2026-08-27"
  },
  "metadata": { "request_id", "processing_time_ms", "data_freshness" },
  "error": null
}

Поля верхнего уровня одинаковы у всех модулей: статус, признак успеха, имя модуля, полезные данные, метаданные запроса и ошибка. Внутри data лежат записи источника, статистика и риск-профиль.

Дата актуальности данных приходит отдельным полем: это позволяет отличить «в источнике пусто» от «источник обновлялся месяц назад».

Финсектору

Формат Открытых API Банка России

Конверт Data / Risk / Links / Meta

# Тот же запрос, конверт в конвенциях Открытых API ЦБ (СТО БР)
curl -X POST https://api.inforensic.pro/v2/open-banking/v1.0/checks/\
  compliance.rus.fns_disqualified \
  -H "X-API-Key: $CONTEXT_KEY" -H "x-fapi-interaction-id: $(uuidgen)"

{
  "Data":  { "found": true, "total_count": 1, "results": [ /* записи */ ] },
  "Risk":  { "overall_risk_level": "C_ORANGE", "flags": [ … ] },
  "Links": { "self": "/v2/open-banking/v1.0/checks/…" },
  "Meta":  { "totalResults": 1, "interactionId": "…", "lastAvailableDateTime": "2026-09-06T00:00:00Z" }
}

Для банков и финтеха те же проверки доступны в конвенциях Открытых API ЦБ (комплекс стандартов СТО БР): конверт Data / Risk / Links / Meta, единая модель ошибок с точечными кодами, корреляция x-fapi-interaction-id, даты ISO 8601 с таймзоной. Риск-профиль проверки ложится в секцию Risk.

Интегратору, работавшему с открытым банкингом, конверт знаком, а команде не нужен отдельный адаптер. Спецификация OpenAPI 3.0 собирается из живого реестра модулей и доступна без ключа.

Это совместимость по форме и безопасности, а не по предметному стандарту: прикладного стандарта ЦБ под данные проверок не существует, поэтому содержимое Data остаётся в схеме платформы. Ключ и тарификация те же.

Задачи

Статусы асинхронного выполнения

  • Статус PENDING
    Что означает Задача принята и стоит в очереди
  • Статус STARTED
    Что означает Исполнитель взял задачу в работу
  • Статус PROGRESS
    Что означает Выполняется, приходит поле progress от 0 до 100
  • Статус COMPLETED
    Что означает Завершена, результат доступен
  • Статус FAILED
    Что означает Завершена с ошибкой, средства возвращены
  • Код 400
    Причина Запрос не прошёл валидацию
  • Код 401
    Причина Ключ отсутствует или отозван
  • Код 402
    Причина Недостаточно средств на балансе организации
  • Код 404
    Причина Модуль или задача не найдены
  • Код 422
    Причина Поля не соответствуют схеме модуля
  • Код 500
    Причина Внутренняя ошибка, средства возвращены
  • Код 503
    Причина Источник временно недоступен, средства возвращены

При ошибке источника или внутреннем сбое списанные средства возвращаются на баланс автоматически: платить за неполученный ответ не нужно.

N°13 Заявка

Подберём модули под ваш поток проверок

Расскажите о задаче: посчитаем стоимость запроса, предложим пакет, поможем со встраиванием в ваш контур и пришлём договор.

Коммерческие вопросы
sales@inforensic.pro
Поддержка, ответ в течение 48 часов
support@inforensic.pro
Телеграм
@InforensicPro