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

Request

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

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

JWT не требуется
если передан валидный JWT, сервер получает текущий аккаунт из сессии и перед отправкой проверяет, можно ли привязать указанный email
если JWT не передан или сессия не определена, OTP отправляется без проверки привязки
для авторизованного пользователя OTP не отправляется, если у текущего аккаунта уже есть привязанная почта
для авторизованного пользователя один email может использоваться в разных ролях только при том же телефоне
обязателен заголовок 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

Запрос обработан; OTP-код будет отправлен на указанный email

Bodyapplication/json

codeErrorstring or nullrequired

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

successbooleanrequired

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

Example:true

messagestringrequired

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

Example:"OK"

error_codestring or null(ERROR_CODE)required

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

Enum:"invalid_body""unauthorized""not_found""conflict""object_modified_by_another_thread""action_too_late""too_many_request""code_is_gone""forbidden""user_blocked"

Example:null

dataany or nullrequired

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

Example:null

Response

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