Desbloqueio de uma conta

Pré-requisitos

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

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

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Accounts/reset-user

--request POST 'https://sandbox.hiperbanco.com.br/Accounts/reset-user' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
    "onboardingId": "af3e2a0e-2a68-478e-9ba9-9f2b2d009ad4",
    "mfaCode":"111111"
}'

Cabeçalhos (Headers)

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

📘
Nota
O Bearer token utilizado nessa requisição é obtido por meio da rota de Autenticação Gestão do Banco.

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
`onboardingId`	`string`	ID do onboarding.
`mfaCode`	`string`	Sempre enviar este campo com o valor 111111

{
    "onboardingId": "f87fe659-43e6-4818-bd2f-55c29a59fd2e",
    "mfaCode":"111111"
}

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita com sucesso e trará um objeto contendo as informações da conta.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`id`	string	Identificador único da pessoa.
`birthDate`	string	Data de nascimento.
`dateNumberDocumentPhoto`	string	Data de envio da foto do documento.
`documentNumber`	string	Número do documento.
`documentNumberPhoto`	string	Identificador da foto do documento.
`email`	string	Endereço de e-mail cadastrado.
`motherName`	string	Nome da mãe.
`registerName`	string	Nome de registro civil.
`socialName`	string	Nome social.
`status`	string	Status do cadastro.
`reasons`	string	Motivos relacionados ao status, se houver.
`hasBrazilianNationality`	boolean	Indica se possui nacionalidade brasileira.
`phone`	string	Número de telefone no formato internacional.
`isPoliticallyExposedPerson`	boolean	Indica se a pessoa é politicamente exposta.
`type_account`	string	Tipo de conta.
`retry_onboarding`	number	Quantidade de tentativas de onboarding.
`declaredAnnualBilling`	number	Faturamento anual declarado.
`createdAt`	string	Data de criação do registro.
`updatedAt`	string	Data da última atualização do registro.
`deletedAt`	string	Data de exclusão lógica do registro.
`passwordUpdatedAt`	string	Data da última atualização de senha.
`isImported`	boolean	Indica se o registro foi importado.
`occupation`	string	Código da ocupação.
`pep`	string	Classificação de Pessoa Politicamente Exposta.
`declaredIncome`	number	Renda declarada.
`assertedIncome`	number	Renda informada ou atribuída no cadastro.
`nationality`	string	Nacionalidade.
`gender`	string	Gênero.
`relationshipStatus`	string	Estado civil.
`education`	string	Grau de escolaridade.
`documentType`	string	Tipo do documento.
`expirationDateForgotPassword`	string	Data de expiração para redefinição de senha.
`issuerEntity`	string	Órgão emissor do documento.
`ccbPersonId`	string	Identificador do registro em ccb.
`deviceFCMToken`	string	Token do dispositivo para notificações push.
`mfaSecret`	string	Segredo para autenticação multifator.
`deviceModel`	string	Modelo do dispositivo utilizado.
`importStatus`	string	Status do processo de importação.
`authBlocked`	array	Lista de registros de bloqueio de autenticação.
`authBlocked[].id`	string	Identificador único do bloqueio.
`authBlocked[].correlationId`	string	Identificador de correlação do evento.
`authBlocked[].type`	string	Tipo de bloqueio.
`authBlocked[].reason`	string	Motivo do bloqueio.
`authBlocked[].createdAt`	string	Data de criação do bloqueio.
`authBlocked[].updatedAt`	string	Data da última atualização do bloqueio.
`authBlocked[].deletedAt`	string	Data de exclusão lógica do bloqueio.

{
  "id": "5214cfed-5712-45b6-a2fb-4677290a5a92",
  "birthDate": "1997-01-04",
  "dateNumberDocumentPhoto": "2023-09-01T03:00:00.000Z",
  "documentNumber": "53532638711",
  "documentNumberPhoto": "798443026",
  "email": "[email protected]",
  "motherName": "Juliana Juliana Costa",
  "registerName": "Raquel Fernanda Souza",
  "socialName": "Raquel Souza",
  "status": "APPROVED",
  "reasons": "",
  "hasBrazilianNationality": true,
  "phone": "5561985122032",
  "isPoliticallyExposedPerson": false,
  "type_account": "PF",
  "retry_onboarding": 1,
  "declaredAnnualBilling": null,
  "createdAt": "2025-11-13T16:49:13.301Z",
  "updatedAt": "2025-11-13T16:49:55.000Z",
  "deletedAt": null,
  "passwordUpdatedAt": null,
  "isImported": false,
  "occupation": "OCP0001",
  "pep": "NONE",
  "declaredIncome": null,
  "assertedIncome": 50262.1,
  "nationality": "BRASILEIRO",
  "gender": "FEMININO",
  "relationshipStatus": "SOLTEIRO",
  "education": "NAO_ALFABETIZADO",
  "documentType": null,
  "expirationDateForgotPassword": null,
  "issuerEntity": "SSP/BA",
  "ccbPersonId": null,
  "deviceFCMToken": null,
  "mfaSecret": null,
  "deviceModel": null,
  "importStatus": null,
  "authBlocked": [
    {
      "id": "0f7afa48-aef4-4dc6-9a17-567dfc3d834a",
      "correlationId": "6f5855cf-f65f-463d-a1f8-325091a2162f",
      "type": "BLOCKED_BY_ADMIN",
      "reason": "COMMERCIAL_DISAGREEMENT",
      "createdAt": "2025-11-13T23:56:39.000Z",
      "updatedAt": "2025-11-13T23:56:39.000Z",
      "deletedAt": null
    }
  ]
}

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 with ID 0a50a787-5ec5-4120-a34e-3485f7d98c8b.	Onboarding não encontrado com ID ab332502-7136-455d-94ee-994eb34ff431.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.