Atualização da senha

Este endpoint permite a criação de uma nova senha.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O usuário tenha o token de 4 dígitos recebido via SMS.
O token esteja dentro do prazo de validade.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Onboarding/forgot-password/update

--request POST 'https://sandbox.hiperbanco.com.br/Onboarding/forgot-password/update' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cpf": "01236547896",
    "clientId": "c82855e0-e61c-4aa3-9953-5cb356d09538",
    "token": "1111",
    "newPassword": "NovaSenha123@"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`cpf`	`string`	Obrigatório. CPF ou CNPJ do usuário.	11 a 14 caracteres.
`clientId`	`string`	Obrigatório. Id do cliente.	—
`token`	`string`	Obrigatório. Token de 4 dígitos enviado SMS.	Mín. 4, máx. 4 caracteres.
`newPassword`	`string`	Obrigatório. A nova senha de acesso.	—

{
    "cpf": "01236547896",
    "clientId": "c82855e0-e61c-4aa3-9953-5cb356d09538",
    "token": "1111",
    "newPassword": "NovaSenha123@"
}

Resposta (Response)

O status code 200 indicará que a senha foi atualizada com sucesso.

Erros

Status code	Código	Mensagem	Descrição
`403`	`INVALID_MFA_CODE`	The multi-factor authentication code provided is incorrect or invalid.	O código do SMS está incorreto ou expirado.

Eventos

Este endpoint não possui eventos relacionados a ele.