GET /api/v1/checks и GET /api/v1/checks/{check_id}

Список и опрос статуса проверок

Методы позволяют получить историю API-проверок и забрать финальный результат по check_id. Если события интеграции не используются, опрашивайте статус этим методом.

Открыть в Swagger API в базе знаний

Кратко для ИИ

Когда использовать

Экран истории в CRM, периодический опрос статуса, восстановление результата после сетевого сбоя.

Карта методов

Связанные методы

Эта страница описывает группу связанных методов. Для точной схемы параметров используйте Swagger, для продуктовой логики — блоки ниже.

GET/api/v1/checks

Список проверок по этому API-ключу.

GET/api/v1/checks/{check_id}

Полный статус и результат одной проверки.

Сценарий

Как проходит сценарий

Шаг 1

Список

Используйте фильтры status/type и пагинацию limit/offset.

Шаг 2

Карточка проверки

По check_id получите детальный result, pdf_url и доказательный блок.

Шаг 3

Безопасный повтор

Опрос статуса не списывает баланс, поэтому его можно повторять по расписанию.

Обязательные поля

Поле	Обяз.	Описание
id	Да	check_id из ответа POST /checks.
status	Нет	Фильтр списка: processing, report_ready, partial, failed.
limit/offset	Нет	Пагинация списка проверок.

Пример curl

curl "https://api.realiq.ru/api/v1/checks?status=report_ready&type=full&limit=20" \
  -H "X-API-KEY: riq_live_xxx"

JSON-запрос

Пример JSON-запроса

Для GET-методов показано JSON-представление URL, query-параметров и заголовков. Для загрузки файла показана структура form-data.

{
  "method": "GET",
  "endpoint": "/api/v1/checks",
  "query": {
    "status": "report_ready",
    "type": "full",
    "limit": 20,
    "offset": 0
  },
  "headers": {
    "X-API-KEY": "riq_live_xxx"
  }
}

JSON-ответ

Пример успешного JSON-ответа

Пример отражает структуру реального ответа API. Значения ID, SHA и ссылок сокращены или заменены демонстрационными.

{
  "items": [
    {
      "check_id": "b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a",
      "status": "report_ready",
      "type": "full",
      "created_at": "2026-06-28T12:00:00Z",
      "completed_at": "2026-06-28T12:01:18Z",
      "pdf_url": "https://realiq.ru/reports/b9f6f2f0.pdf",
      "report_url": "https://realiq.ru/check-status/b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a",
      "risk_score": 18,
      "cost": 650
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0,
  "request_id": "req_1780000000_abcd"
}

Полный JSON-ответ

Полный пример ответа

Развёрнутый пример показывает, какие блоки обычно получает интегратор. Значения ID, SHA, ссылок и персональных данных демонстрационные.

{
  "items": [
    {
      "check_id": "b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a",
      "status": "report_ready",
      "type": "full",
      "created_at": "2026-06-28T12:00:00Z",
      "completed_at": "2026-06-28T12:01:18Z",
      "pdf_url": "https://realiq.ru/reports/b9f6f2f0.pdf",
      "report_url": "https://realiq.ru/check-status/b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a",
      "risk_score": 18,
      "cost": 650
    },
    {
      "check_id": "5d2a87e0-0d3c-4d7d-8a6f-3b8c5c4a1f10",
      "status": "processing",
      "type": "seller",
      "created_at": "2026-06-28T12:05:00Z",
      "completed_at": null,
      "pdf_url": null,
      "report_url": null,
      "risk_score": null,
      "cost": 390
    }
  ],
  "total": 2,
  "limit": 20,
  "offset": 0,
  "request_id": "req_1780000000_abcd"
}

Поля ответа

Как читать поля ответа

Поле	Что означает
items[].status	Текущий статус проверки. Если processing — продолжайте опрос статуса.
items[].risk_score	Появляется после расчёта результата.
limit/offset/total	Пагинация истории проверок этого API-ключа.
GET /checks/{check_id}	Для полного результата и доказательного блока используйте карточку конкретной проверки.

Ошибки

Типовые ошибки метода

HTTP 401unauthorized

Неверный API-ключ.

Что делать: Проверьте X-API-KEY.

{
  "error_code": "unauthorized",
  "message": "Неверный API-ключ.",
  "request_id": "req_1780000000_abcd"
}

HTTP 404not_found

Проверка не найдена или принадлежит другому аккаунту.

Что делать: Проверьте check_id и ключ.

{
  "error_code": "not_found",
  "message": "Проверка не найдена или принадлежит другому аккаунту.",
  "request_id": "req_1780000000_abcd"
}

HTTP 422validation_error

Некорректный limit/offset/status.

Что делать: Исправьте query-параметры.

{
  "error_code": "validation_error",
  "message": "Некорректный limit/offset/status.",
  "request_id": "req_1780000000_abcd"
}

Ответ processing

{
  "items": [{ "check_id": "...", "status": "processing", "type": "full" }],
  "total": 1,
  "limit": 20,
  "offset": 0
}

Ответ report_ready

{
  "check_id": "...",
  "status": "report_ready",
  "type": "full",
  "result": { "risk_scoring": { "score": 18 } },
  "evidence": { "check_evidence_root_hash": "...", "sources": [] }
}

Пример ошибки

{
  "error_code": "not_found",
  "message": "Проверка не найдена для этого API-ключа.",
  "request_id": "req_..."
}

Что списывается с баланса

Опрос статуса и список не списывают баланс.

Какие поля доказательного блока вернутся

Финальный GET возвращает доказательный блок проверки.
Список отдаёт компактную карточку без полного состава источников.