8 - Recuperação de senha

7.0 - Conceituação

• Essa seção visa descrever as rotas do escopo recuperação de senha.

7.1 - Recuperar senha

Este endpoint inicia o processo de recuperação de senha para o cliente informado. Ao realizar a solicitação, um código de verificação será enviado para o e-mail cadastrado do usuário

[POST] /api/v1/user/recoverypassword

[HEADER]

[PAYLOAD]

{
    "document": "12345678910"
}

[RESPONSES]

• 200

{
    "success": true,
    "message": "Recuperação de senha realizada com sucesso",
    "code": 200
}

7.2 - Confirmar codigo

Este endpoint permite validar o código de recuperação de senha enviado para o e-mail do usuário durante o processo iniciado no endpoint de recuperação de senha. Após a validação bem-sucedida do código informado, o usuário estará apto a prosseguir para a próxima etapa, onde poderá definir uma nova senha de acesso para sua conta.

[POST] /api/v1/user/confirmrecoverycode

[HEADER]

[PAYLOAD]

{
    "document": "12345678910",
    "recoverycode": "54321"
}

[RESPONSES]

• 200

{
    "success": "true",
    "code": "200",
    "message": "Código de recuperação validado com sucesso"
}

7.3 - Alterar senha

Este endpoint conclui o processo de recuperação de senha, permitindo que o usuário defina uma nova senha de acesso. Para realizar a alteração, é necessário informar o documento do usuário, o código de recuperação validado anteriormente e a nova senha desejada. Os campos password e password_confirmation devem possuir o mesmo valor para que a alteração seja efetuada com sucesso.

[POST] /api/v1/user/commitchangepassword

[HEADER]

[PAYLOAD]

{
    "document": "12345678901",
    "recoverycode": "847291",
    "newpassword": "NovaSenha@2026",
    "confirmnewpassword": "NovaSenha@2026"
}

[RESPONSES]

• 200

{
    "success": "true",
    "code": "200",
    "message": "Senha alterada com sucesso"
}

• 400

{
    "success": false,
    "message": "Tempo excedido",
    "code": 400
}