Consultar todas as contas criadas

Este endpoint permite realizar a consulta de todas as contas criadas no banco

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessario que:

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

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/dashboard/accounts?page=1&perPage=20&search={{documentNumber}}&orderColumn=createdAt&orderDirection=DESC

--request GET 'https://sandbox.hiperbanco.com.br/dashboard/accounts?page=1&perPage=20&search={{documentNumber}}&orderColumn=createdAt&orderDirection=DESC' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

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.

Parâmetros da rota (Path / Query)

É possivel enviar os seguintes Query Params nesta requisição:

Nome	Tipo	Descrição
`startDate`	`query`	Data inicial da busca. ISO Date Format (YYYY-MM-DD).
`endDate`	`query`	Data final da busca. ISO Date Format (YYYY-MM-DD).
`page`	`query`	Página do resultado da busca
`perPage`	`query`	Itens por página
`search`	`query`	Query de pesquisa - É possivel pesquisar pelo accountNumber, documentNumber, registerName
`orderColumn`	`query`	Coluna para ordenação - Valores possiveis: `createdAt` e `status`
`orderDirection`	`query`	Sentido da ordenação, pode ser `ASC` (ascendente) ou `DESC` (descendente). Funciona apenas se orderColumn tiver sido especificado
`type_user`	`query`	Tipo do usuario: `PF` ou `PJ`
`status`	`query`	Buscar por status da conta - ACTIVE, CLOSE, CLOSED, INACTIVE, DELETED e JUDICIAL_BLOCK

Corpo da requisição (Body)

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

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações das contas criadas

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

Campo	Tipo	Descrição
`data[]`	array	Lista de contas retornadas
`data[].id`	string	Identificador da conta
`data[].number`	string	Número da conta
`data[].createdAt`	string	Data de criação da conta (ISO 8601)
`data[].type`	string	Tipo da conta (ex: `MAIN`)
`data[].agencies`	object	Informações da agência vinculada
`data[].agencies.id`	string	ID da agência
`data[].agencies.agency_name`	string	Nome da agência
`data[].agencies.branch`	string	Número da agência (ex: `0001`)
`data[].plan`	object	Informações do plano vinculado
`data[].plan.id`	string	ID do plano
`data[].status`	string	Status da conta (ex: `Ativa`)
`data[].onboarding`	object	Informações do titular da conta
`data[].onboarding.id`	string	ID do processo de onboarding
`data[].onboarding.documentNumber`	string	CPF ou CNPJ do titular
`data[].onboarding.email`	string	Email do titular
`data[].onboarding.registerName`	string	Nome civil do titular
`data[].onboarding.socialName`	string	Nome social do titular
`data[].onboarding.type_account`	string	Tipo de conta (ex: `PF`)
`data[].onboarding.deletedAt`	string	Data de exclusão (se houver)
`data[].onboarding.client`	object	Cliente vinculado ao onboarding
`data[].onboarding.client.id`	string	ID do cliente
`data[].onboarding.isBlocked`	boolean	Indica se a conta está bloqueada
`total`	number	Total de registros encontrados
`totalPages`	number	Total de páginas de resultados

{
  "data": [
    {
      "id": "d3b3a111-9b4e-41df-9f5b-77a7c5d7d001",
      "number": "1104645413",
      "createdAt": "2025-05-13T14:32:53.145Z",
      "type": "MAIN",
      "agencies": {
        "id": "b4d32918-aaaa-47fe-84a4-f3d2c0c8a33d",
        "agency_name": "Agência Centro-Oeste",
        "branch": "1000"
      },
      "plan": {
        "id": "f8dd1c06-c6a4-491c-aff4-4d2dad036c1c"
      },
      "status": "Ativa",
      "onboarding": {
        "id": "c7a9123b-a456-4bd8-a74f-e4d2d28f45cb",
        "documentNumber": "32165498700",
        "email": "[email protected]",
        "registerName": "Silas Moreira",
        "socialName": "Silas M.",
        "type_account": "PF",
        "deletedAt": null,
        "client": {
          "id": "f23e9a7b-4211-47d7-a49f-e9f13250a124"
        },
        "isBlocked": false
      }
    },
    {
      "id": "a9f05f78-cf61-4e87-b4e1-b24d411ea032",
      "number": "1103336549",
      "createdAt": "2025-03-10T09:38:56.204Z",
      "type": "MAIN",
      "agencies": {
        "id": "03d23819-f5c8-11ef-9fc4-1221ddcea5ad",
        "agency_name": "Agência Sul",
        "branch": "0001"
      },
      "plan": {
        "id": "f8dd1c06-c6a4-491c-aff4-4d2dad036c1c"
      },
      "status": "Ativa",
      "onboarding": {
        "id": "df8f8421-5a44-4f9b-a5dc-8e51d972a029",
        "documentNumber": "20458739012",
        "email": "[email protected]",
        "registerName": "Ana Júlia Batista",
        "socialName": "Ana Batista",
        "type_account": "PF",
        "deletedAt": null,
        "client": {
          "id": "f23e9a7b-4211-47d7-a49f-e9f13250a124"
        },
        "isBlocked": false
      }
    }
  ],
  "total": 100,
  "totalPages": 50
}

Erros

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