Alterar e-mail ou telefone do onboarding

Este endpoint possibilita a alteração do e-mail ou telefone de um onboarding em andamento.

Pré-requisito

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

O usuário esteja utilizando a Autenticação Gestão do Banco

Requisição (Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/dashboard/changeEmailOrPhone/{onboardingId}

curl --location --request PATCH 'https://sandbox.hiperbanco.com.br/dashboard/changeEmailOrPhone/{{onboardingId}}' \
--header 'version: cutting-edge' \
--data '{
    "phone": "5511988776655",
    "email": "[email protected]",
    "code": "111111"
}'

Nome	Propriedade	Descrição
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição	Especificação
`onboardingId`	`path`	Obrigatório. ID do onboarding.	UUID

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`phone`	`string`	Número de telefone do cliente, incluindo DDI e DDD.
`email`	`string`	Endereço de e-mail do cliente.
`code`	`string`	Obrigatório. Código de verificação com exatamente 6 caracteres numéricos. Em sandbox, utilize `"111111"`.

📘
Nota
Ao menos um dos campos phone ou email deve ser informado. O campo code é sempre obrigatório.

{
    "phone": "5511988776655",
    "email": "[email protected]",
    "code": "111111"
}

Resposta (Response)

O status code 200 indicará sucesso na operação.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`404`	`ONBOARDING_NOT_FOUND`	Onboarding not found.	Ocorre quando o `onboardingId` informado não é encontrado.

Eventos

Este endpoint não possui eventos relacionados a ele.