Коды ошибок

Тело каждого JSON-ответа включает поле status. Его значение success для успешно выполненных запросов или error при возникновении какой-либо ошибки. У каждого ошибочного ответа есть соответствующий код статуса HTTP и следующие поля JSON:

error_code
Код ошибки, см. ниже описания, сгруппированные по коду статуса HTTP
error_id
Уникальный идентификатор ошибочного ответа для справки
messages
Массив или объект сообщений об ошибке. Если это объект, названия его полей соответствуют названиям JSON-полей запроса.

HTTP 401 Unauthorized

auth.apikey.missing
В запросе отсутствует заголовок X-Api-Key, который должен содержать API-ключ клиентского приложения.
auth.apikey.invalid
API-ключ, переданный в заголовке запроса X-Api-Key, недействителен.
auth.header.missing
В запросе отсутствует заголовок Authorization, который должен содержать токен аутентификации или подпись запроса.
auth.header.invalid
Формат заголовка запроса Authorization неверен. Требуется формат Bearer <сессионный_токен> либо Signature <signature>.
auth.token.expired
Заголовок запроса Authorization или поле запроса token содержит истекший токен аутентификации.
auth.token.invalid
Заголовок запроса Authorization или поле запроса token содержит недействительный токен аутентификации.
auth.signature.invalid
Заголовок запроса Authorization содержит недействительную подпись запроса.
auth.signature.expired
Заголовок запроса Authorization содержит истекшую подпись запроса.
auth.captcha.missing
Запрос должен включать поле captcha_response, которое отсутствует.
auth.captcha.invalid
Поле запроса captcha_response содержит недействительный ответ captcha.
auth.session.invalid
Состояние пользовательской сессии недействительно для этого запроса.
auth.password.invalid
Запрос передал неверный текущий пароль пользователя.
auth.otp.invalid
Поле запроса otp содержит неверный одноразовый код (OTP).
auth.backupcode.invalid
Поле запроса backup_code содержит неверный резервный одноразовый код.
auth.memorable.invalid
Поле запроса memorable_letters содержит неверные буквы памятных слов пользователя.
auth.controlanswer.invalid
Поле запроса control_answer содержит неверный ответ на контрольный вопрос для восстановления.
auth.disclaimer.invalid
Поле запроса accept_disclaimers не содержит юридического соглашения, которое должен принять пользователь.
auth.oauth.failed
Проверка в провайдере OAuth не удалась.

HTTP 403 Forbidden

auth.user.restricted
Профилю пользователя в настоящее время запрещено использование любых вызовов API, требующих авторизацию.
auth.user.closed
Профиль пользователя закрыт, ему запрещено использование любых вызовов API, требующих авторизацию.
auth.user.denied
Профилю пользователя административно отказано в сервисе.
auth.restricted
Запрос не может быть выполнен с представленными данными из-за ограничений доступа.
recovery.question.notset
Запрошено восстановление доступа с помощью секретного вопроса для пользователя без установленного секретного вопроса.
recovery.phone.notset
Запрошено восстановление доступа с помощью телефона для пользователя без установленного основного номера телефона.
recovery.email.notset
Запрошено восстановление доступа с помощью электронной почты для пользователя без установленного основного адреса почты.
recovery.method.restricted
Запрошенный метод восстановления доступа запрещен.
profile.identifier.used
Переданный в запросе основной идентификатор профиля (основной номер телефона или основной адрес электронной почты) уже использован.
profile.identifier.invalid
Переданный в запросе основной идентификатор профиля (основной номер телефона или основной адрес электронной почты) некорректен.
oauth.identifier.used
Идентификатор пользователя OAuth, переданный для экземпляра, уже используется в экземпляре того же клиента.
object.limit.exceeded
Попытка добавить объекты сверх максимального лимита.
critical.auth.required

Для выполнения этого запроса требуется выполнение аутентификации для критических изменений.

Если поле ответа critical_auth_method содержит password, клиентскому приложению следует повторить запрос, передавая поле password, содержащее правильный пароль пользователя.

Если поле ответа critical_auth_method содержит otp, на телефон пользователя было отправлено SMS с одноразовым кодом (OTP). Клиентскому приложению следует повторить запрос, передавая поле otp, содержащее правильный одноразовый код.

member.data.invalid
Данные участника, переданные для проверки экземпляра участника, неверны.
search.type.restricted
Запрошенный тип объекта для поиска запрещен.

HTTP 404 Not Found

auth.oauth.notfound
Проверка OAuth вернула идентификатор пользователся, который не найден.
auth.loginid.notfound
Поле запроса login_id содержит идентификатор для входа пользователя, который не найден.
object.id.notfound
Запрошенный идентификатор объекта не найден.

HTTP 422 Unprocessable Entity

request.validation.failed
Данные запроса либо содержат некорректный JSON, либо не прошли проверку значений полей.