SOAR API Documentation

Verificação de Código OTP

Verifica se o código OTP informado para o e-mail é válido e ainda está dentro do prazo de expiração.

POST

/auth/verify-otp

Parâmetro	Valor
Content-Type	application/json

Campo	Tipo	Obrigatório	Descrição
email	string	Sim	E-mail do usuário.
otp	string	Sim	Código de verificação enviado por e-mail.

{
  "email": "user@email.com",
  "otp": "123456"
}

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

{
  "success": true,
  "code": 200,
  "message": "OTP code is valid.",
  "email": "user@email.com"
}

{
  "status": 400,
  "error": 400,
  "messages": {
    "error": "The email and OTP code fields are required."
  }
}

{
  "status": 404,
  "error": 404,
  "messages": {
    "error": "Invalid or expired OTP code."
  }
}