POST /api/v1/company

Проверка компании или ИП

Проверка компании или ИП по ИНН, ОГРН или ОГРНИП. Тип определяется по реквизитам и подтверждается через /company/resolve. Для ИП используются подходящие источники; корпоративная бухгалтерская отчётность не применяется.

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

Метод RealIQPOST /api/v1/company

Вход4 полей схемы→Обработкаstatus + request_id→Результат3 доказательных полей

Кратко для ИИ

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

Проверка продавца, покупателя, арендатора, подрядчика или застройщика. Для существующего API-ключа включите право company.

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

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

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

POST/api/v1/company/resolve

Без списания: identifier и data_processing_consent=true. Покажите полученные company.inn/ogrn пользователю для подтверждения.

POST/api/v1/company/quote

Без тела: текущая цена, тариф, balance_sufficient; цена не резервируется.

POST/api/v1/company

Запуск с Idempotency-Key; HTTP 202, check_id. Сохраняйте тело и ключ при сетевом повторе.

GET/api/v1/company/{check_id}

processing/report_ready/failed, progress, result_data, certificate и pdf_url.

GET/api/v1/jobs

service=company, client_reference, limit/offset. Только задачи текущего ключа.

GET/api/v1/reports/{external_id}/download

Приватный PDF с исходным ключом: 409 — не готов, 410 — недоступен, 404 — чужой.

Сценарий

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

Шаг 1

Подтвердите реквизиты

Вызовите resolve и получите согласие пользователя. Sandbox resolve принимает учебную компанию: ИНН 7707083893 / ОГРН 1027700132195, либо ИП: ИНН 500100732259 / ОГРНИП 304500116000157. Ответ помечен demonstration и не является реестровой проверкой.

Шаг 2

Покажите цену и запустите

Quote, затем POST /company. До двух активных проверок на агентство, 12 запусков и 30 resolve в час, плюс лимиты API. Лишние поля, deal_id и previous_id не принимаются.

Шаг 3

Получите результат

GET /company/{check_id} или webhook check.completed (включая status=failed); результат события в data.result. Sandbox сразу report_ready с неполными учебными данными, без PDF.

Шаг 4

Учтите срок хранения

Повтор POST возвращает квитанцию, не продлевает хранение. Новая покупка требует нового Idempotency-Key. Оригиналы источников, финансовые дополнения и перевыпуск презентации доступны в кабинете.

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

Поле	Обяз.	Описание
identifier	Да	ИНН компании (10 цифр) или ИП (12), ОГРН (13) либо ОГРНИП (15). Проверяется контрольная сумма.
confirmed_company	Да	Пара inn/ogrn из resolve, подтверждённая пользователем. Для ИП поле ogrn содержит ОГРНИП. identifier должен совпадать с одним из реквизитов.
role	Нет	seller (по умолчанию), buyer, tenant, contractor или developer.
data_processing_consent	Да	true — подтверждение законного основания обработки данных.

Пример curl

curl -X POST https://api.realiq.ru/api/v1/company \
  -H "X-API-KEY: riq_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: crm-company-1001" \
  -H "X-Client-Reference: crm-company-1001" \
  -d '{"identifier":"7707083893","confirmed_company":{"inn":"7707083893","ogrn":"1027700132195"},"role":"seller","data_processing_consent":true}'

JSON-запрос

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

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

{"identifier":"7707083893","confirmed_company":{"inn":"7707083893","ogrn":"1027700132195"},"role":"seller","data_processing_consent":true}

JSON-ответ

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

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

{"check_id":"b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a","status":"processing","mode":"live","cost":249,"price_amount":249,"balance_remaining":4751,"request_id":"req_company_1"}

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

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

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

{"check_id":"b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a","status":"report_ready","mode":"live","cost":249,"price_amount":249,"result_data":{"assessment_state":"incomplete","sources":[]},"pdf_url":"/api/v1/reports/b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a/download","request_id":"req_company_2"}

Поля ответа

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

Поле	Что означает
check_id/status	UUID задачи и состояние processing/report_ready/failed.
result_data	Компания, источники, факты, покрытие и выводы; при processing/failed — null. Нет данных не означает нулевой риск.
progress	Этапы identity/sources/analysis/report без внутренних путей и ошибок провайдеров.
certificate/pdf_url/expires_at	Сертификат, приватный PDF и предел хранения; скачивание требует исходного ключа.
error	При failed: company_check_failed, безопасное сообщение и retryable. Повторная покупка — новый Idempotency-Key.

Ошибки

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

HTTP 422invalid_company_input

Нет согласия или неверный sandbox идентификатор.

Что делать: Проверьте согласие и реквизиты; ошибки схемы возвращают validation_error.

{"error_code":"invalid_company_input","message":"Подтвердите законное основание обработки данных.","request_id":"req_company_1"}

Ответ processing

{"check_id":"b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a","status":"processing","mode":"live","cost":249,"price_amount":249,"balance_remaining":4751,"request_id":"req_company_1"}

Ответ report_ready

{"check_id":"b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a","status":"report_ready","mode":"live","cost":249,"price_amount":249,"result_data":{"assessment_state":"incomplete","sources":[]},"pdf_url":"/api/v1/reports/b9f6f2f0-b8c1-4f1c-bb8f-3cf3a9dc3b5a/download","request_id":"req_company_2"}

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

{"error_code":"invalid_company_input","message":"Подтвердите законное основание обработки данных.","request_id":"req_company_1"}

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

Resolve и quote бесплатны. Запуск возвращает HTTP 202. Старт 249 ₽, Базовый 99 ₽, Стандарт 79 ₽, Профи 59 ₽, Бизнес 39 ₽, Эксперт 29 ₽. Quote не резервирует цену. Повтор с тем же ключом и телом не списывает снова. При ошибке формирования списание возвращается. Sandbox: 0 ₽, без источников и PDF.

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

result_data содержит сведения компании, покрытие источников и выводы. Неполнота не означает отсутствие риска; пример ответа сокращён.
certificate содержит SHA-256 PDF и снимка, системную временную метку; это не квалифицированная электронная подпись.
PDF требует исходный X-API-KEY и доступен до expires_at. Чужой ключ получает 404, истёкший отчёт — 410.