Проверить ключ и получить организацию
Обновлено 8 октября 2026
GET
/meПроверяет ключ и возвращает сведения об организации. Не запускает проверку документов и не списывает проверки. Отдельный вход не требуется.
Передайте ключ организации в заголовке Authorization: Bearer <ключ>.
Пример запроса
Используйте NK_BASE и NK_KEY из быстрого старта. Переменные в пути, например RUN_ID, замените значениями из ваших ответов API.
curl --fail-with-body "$NK_BASE/me" \
-H "Authorization: Bearer $NK_KEY"Ответы и ошибки
200
Успешный ответ.
application/json
Поля ответа
tenant_idстрока · обязательное- Организация, к которой относится ключ.
nameстрока · обязательное- Название организации.
sectionsмассив: строка · обязательное- Разделы профиля проверки.
Вложенные поля
Массив элементов:
Код раздела.
checks_leftцелое число · обязательное- Остаток проверок по условиям доступа.
tariffстрока · обязательное- Код тарифа.
webhook_configuredда / нет · обязательное- Наличие адреса уведомлений. Если значение равно false, используйте опрос.
401
Ключ не передан, неверен или отозван.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
403
Доступ закрыт или действие не разрешено.
application/json
Поля ответа
detailобъект / массив: объект / строка · обязательное- Обычно объект с error. При ошибке проверки параметров возможен список нарушений.
Вложенные поля
errorстрока · обязательное- Машинный код ошибки. Используйте его в обработчике.
messageстрока · необязательное- Пояснение для человека. Текст может меняться.
fileстрока · необязательное- Проблемный файл, если ошибка относится к нему.
Массив элементов:
locмассив: строка / целое число · необязательное- Путь до неверного поля.
msgстрока · необязательное- Причина нарушения.
typeстрока · необязательное- Код нарушения.
inputобъект · необязательное- Переданное значение.
Текст ошибки, если сервер не вернул объект.
Другой ответ
Ошибка входного сервера или сети может иметь текстовое/HTML-тело. Проверяйте HTTP-статус и Content-Type.