Skip to content

Отправить OTP на email

Request

Отправляет OTP-код на указанный email.

Особенности:

  • JWT не требуется
  • если передан валидный JWT, сервер получает текущий аккаунт из сессии и перед отправкой проверяет, можно ли привязать указанный email
  • если JWT не передан или сессия не определена, OTP отправляется без проверки привязки
  • для авторизованного пользователя OTP не отправляется, если у текущего аккаунта уже есть привязанная почта
  • для авторизованного пользователя один email может использоваться в разных ролях только при том же телефоне
  • после успешной отправки data.retry.TTL содержит фактическое количество секунд до следующей разрешённой отправки email-кода
  • при повторном запросе во время cooldown сервер возвращает 429, а строковое значение времени находится в data.TTL
  • обязателен заголовок captcha-token
Headers
captcha-tokenstringrequired

Одноразовый токен Yandex SmartCaptcha.

Передаётся в заголовке: captcha-token: <token>

Bodyapplication/jsonrequired
recipientstring, (email), <= 254 charactersrequired
Example:"user@example.com"
curl -i -X POST \
  https://felmee.com/api/auth/email/send/otp \
  -H 'Content-Type: application/json' \
  -H 'captcha-token: string' \
  -d '{
    "recipient": "user@example.com"
  }'

Responses

Запрос обработан; возвращён актуальный TTL следующей отправки email-кода

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"INVALID_BODY""INVALID_DATE""invalid_body""unauthorized""not_found""slot_unavailable""conflict""BUSINESS_INACTIVE""INSUFFICIENT_FUNDS""REQUISITES_REQUIRED"
dataobject or null(EmailSendOtpSuccessData)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{ "success": true, "message": "If the address is available for binding, we will send a code to it.", "codeError": null, "error_code": null, "data": { "retry": { … } } }