API RealIQ для CRM, банков и корпоративных платформ
Публичный API v1 позволяет запускать проверки продавца, объекта, документов, оценку и мониторинг программно. Ответы включают статус, результат, PDF-ссылки, события интеграции и доказательный блок: SHA-256, метку времени и цифровые следы источников.
Минимальный старт
Первый запрос специально простой: только `X-API-KEY` и один `curl`. Боевые настройки подключаются после проверки базового сценария.
Старт
Для ИИ
Подключение через ChatGPT, Claude, Cursor или Codex
Для ИИ-инструментов есть отдельный файл /llms.txt и готовый промпт. Передайте их кодогенератору вместе с OpenAPI-схемой, чтобы он собрал клиент без ручной расшифровки документации.
Быстрый старт
Первый запрос без лишней сложности
Создайте тестовый ключ в кабинете и отправьте один запрос. Тестовый режим не списывает баланс и не вызывает реальные источники, но возвращает тот же тип структуры ответа.
curl -X POST https://api.realiq.ru/api/v1/checks \
-H "Content-Type: application/json" \
-H "X-API-KEY: riq_test_xxx" \
-d '{"type":"seller","input_data":{"seller":{"last_name":"Иванов","first_name":"Иван","birth_date":"1980-01-01","region":"Москва"}}}'Авторизация
API-ключ передаётся в заголовке X-API-KEY. Тестовый ключ нужен для разработки, боевой ключ запускает реальные проверки и может списывать баланс. Секреты храните только на серверной стороне своей системы.
Методы v1
POST /api/v1/checks/quote
Предрасчёт стоимости проверки
Метод показывает стоимость одной проверки или пакета без запуска источников. Его используют перед оплатой, чтобы CRM могла заранее показать цену и проверить достаточность баланса.
Открыть методPOST /api/v1/checks
Проверка продавца, объекта или продавец + объект
Основной метод запускает проверку продавца, объекта или комплексную проверку сделки. Проверка выполняется асинхронно: API сразу возвращает check_id, а результат забирается опросом статуса или событием интеграции.
Открыть методPOST /api/v1/checks/bulk
Пакетный запуск проверок
Пакетный метод создаёт несколько независимых проверок одним запросом. Частичный успех допустим: по каждому элементу возвращается свой результат или понятная ошибка.
Открыть методGET /api/v1/checks и GET /api/v1/checks/{check_id}
Список и опрос статуса проверок
Методы позволяют получить историю API-проверок и забрать финальный результат по check_id. Если события интеграции не используются, опрашивайте статус этим методом.
Открыть методPOST /api/v1/document-check
Проверка документов
Метод принимает файл и запускает анализ документа. Результат забирается по job_id: статус, найденные условия, риск-факторы, PDF и доказательный блок.
Открыть методPOST /api/v1/valuation
Оценка объекта
Метод запускает оценку объекта по кадастровому номеру и доступным параметрам. POST сразу возвращает id, статус, стоимость и результат, если оценка сформирована синхронно; метод опроса возвращает полный доказательный блок.
Открыть методPOST /api/v1/monitors
Мониторинг проверки во времени
Мониторинг создаёт регулярную лёгкую перепроверку продавца, объекта или комплексной проверки. Каждый цикл сравнивается с предыдущим снимком и формирует событие, список изменений и лёгкий акт.
Открыть методGET /api/v1/balance и GET /api/v1/tariffs
Баланс и тарифы
Методы дают программную сверку баланса, валюты, активного пакета и тарифных цен. Их используют перед запуском проверок и в финансовом интерфейсе партнёра.
Открыть методGET /api/v1/verify/{sha256}
Проверка цифрового следа
Метод проверяет, относится ли SHA-256 к отчёту, снимку данных, корневому хешу доказательного блока или хешу манифеста внутри аккаунта API-ключа.
Открыть методСобытия интеграции
URL событий задаётся для API-ключа или отдельной подписки мониторинга. RealIQ отправляет события `check.completed`, `monitor.cycle_completed`, `monitor.change_detected` и `monitor.paused`.
Подпись HMAC
Подпись считается по сырому телу запроса до JSON-парсинга: HMAC_SHA256(timestamp + "." + raw_body, webhook_secret). Проверяйте timestamp и отклоняйте слишком старые события.
X-RealIQ-Timestamp: 1780000000
X-RealIQ-Signature: 3d2f...Защита от дублей
Для боевых запусков передавайте уникальный Idempotency-Key. Повтор с тем же ключом вернёт ту же задачу и не создаст повторное списание. Если тело изменилось, API вернёт 409.
Права и лимиты
Ключ ограничивается правами доступа: проверка продавца, объекта, сделки, метод документов document-check, оценка, мониторинг, баланс и проверка отчёта. При превышении лимитов API возвращает 429 и заголовки rate-limit/Retry-After.
Доказательный блок
Финальные ответы возвращают доказательный блок: корневой хеш проверки, SHA PDF, SHA снимка данных, метку времени и хеши источников. Это фиксирует, что именно проверялось и какой цифровой след был сформирован.
Ошибки
Ошибка возвращается в едином формате {error_code,message,request_id}. Для интерфейса партнёра показывайте действие: проверить ключ, пополнить баланс, повторить позже или снизить параллельность.
Тестовый режим
Тестовый режим нужен для разработки и автотестов интеграции: баланс не списывается, реальные источники и ИИ не вызываются, а структура ответа совпадает с боевым режимом.