Envia um SMS para obtenção do token

Este endpoint é utilizado para iniciar o processo de redefinição de senha, disparando um token de validação via SMS para o número de telefone vinculado ao cadastro do usuário.

Pré-requisitos

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

O CPF ou CNPJ informado esteja vinculado a uma conta ativa no onboarding.
O clientId fornecido corresponda às credenciais da aplicação.

Requisição (Request)

Requisição HTTP

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

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

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. Número do documento do usuário (CPF/CNPJ).	Mín. 11, máx. 14 caracteres.
clientId	string	Obrigatório. Id do cliente fornecido com as credenciais.	—

{
    "cpf": "01236547896",
    "clientId": "c82855e0-e61c-4aa3-9953-5cb356d09538"
}

Resposta (Response)

O status code 201 indicará que o SMS foi enviado com sucesso.

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.