Esqueci Minha Senha

Solicitação de redefinição de senha

Este endpoint é do tipo: Public

Descrição

Solicita recuperação de senha com as seguintes funcionalidades:

Valida formato do e-mail
Disponível para qualquer usuário cadastrado
Gera código OTP de 6 dígitos com validade de 15 minutos
Envia email com código de recuperação via SendGrid
Sempre retorna mensagem de sucesso

Nota: Após receber o código por email, use os endpoints /auth/verify-otp para validar e /auth/reset-password para redefinir a senha.

Importante: Este endpoint sempre retorna mensagem de sucesso. Caso não receba o código em seu email, verifique se digitou o endereço corretamente.

Detalhes do Endpoint

VERBO

POST

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

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 cadastrado no sistema.

Corpo da Requisição

{
  "email": "usuario@exemplo.com"
}

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

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Código de recuperação enviado para seu email"
}

Condição: Email com formato válido informado

Erro - 422 (Dados de validação inválidos)

{
  "success": false,
  "message": "Dados de validação inválidos",
  "errors": {
    "email": [
      "O email é obrigatório."
    ]
  }
}

Condição: E-mail não informado ou com formato inválido

Códigos de Resposta

Código	Descrição
200	Código de recuperação enviado para o email
422	Dados de validação inválidos

Nunciatura Provista