Recuperação de Senha (Enviar OTP)

Descrição

Envia um código de verificação (OTP) para o e-mail informado, permitindo iniciar o processo de redefinição de senha.

Verbo

POST

Endpoint

/auth/forgot-password

Cabeçalhos

Parâmetro Valor
Content-Type application/json

Campos Esperados

Campo Tipo Obrigatório Descrição
email string Sim E-mail do usuário que deseja redefinir a senha.

Corpo da Requisição

{
  "email": "user@email.com"
}

Observação: O corpo da requisição deve ser enviado como JSON no formato raw.

Respostas

Sucesso - 200

{
  "success": true,
  "code": 200,
  "message": "An email has been sent with the recovery code."
}

Erro - 400 (Campo obrigatório)

{
  "status": 400,
  "error": 400,
  "messages": {
    "error": "The email field is required."
  }
}

Erro - 404 (E-mail não encontrado)

{
  "status": 404,
  "error": 404,
  "messages": {
    "error": "Email not found."
  }
}

Códigos de Resposta

  • 200 - OTP enviado com sucesso
  • 400 - Campo obrigatório ausente
  • 404 - E-mail não encontrado