Verificar Código OTP

Validação do código de recuperação de senha

Este endpoint é do tipo: Public

Descrição

Valida o código OTP recebido por email para recuperação de senha com as seguintes funcionalidades:

Valida formato do e-mail
Verifica se o código OTP é válido
Verifica se o código não expirou (15 minutos de validade)
Verifica se o código não foi usado anteriormente
Não invalida o código - apenas valida se está correto e não expirado

Nota: Este endpoint apenas valida o código. Para redefinir a senha, use o endpoint /auth/reset-password.

Importante: Se receber mensagem de código inválido, verifique se digitou corretamente o código e o email.

Detalhes do Endpoint

VERBO

POST

URL BASE

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

ENDPOINT

/auth/verify-otp

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.
otp	string	Sim	Código OTP de 6 dígitos recebido por email.

Corpo da Requisição

{
  "email": "usuario@exemplo.com",
  "otp": "123456"
}

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

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Código válido"
}

Condição: Código OTP válido e não expirado

Erro - 400 (Código inválido ou expirado)

{
  "success": false,
  "message": "Código inválido ou expirado"
}

Condição: Código OTP incorreto, expirado (mais de 15 minutos) ou já utilizado

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

{
  "success": false,
  "message": "Dados de validação inválidos",
  "errors": {
    "email": [
      "O email é obrigatório."
    ],
    "otp": [
      "O código OTP deve ter exatamente 6 dígitos."
    ]
  }
}

Condição: Email ou OTP não informados ou com formato inválido

Códigos de Resposta

Código	Descrição
200	Código OTP válido
400	Código inválido ou expirado
422	Dados de validação inválidos

Nunciatura Provista