Detalhe da conta

Este endpoint fornece informações detalhadas sobre a conta.

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/{id}

--request GET 'https://sandbox.hiperbanco.com.br/dashboard/accounts/{id}' \
--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)

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

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

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:

Campo	Tipo	Descrição
`id`	`string`	Identificador da conta.
`status`	`string`	Status atual da conta.
`number`	`string`	Número da conta.
`createdAt`	`string`	Data de criação da conta.
`type`	`string`	Tipo da conta (ex: MAIN).
`escrowAccountTermsOfUse`	`string`	Termos de uso da conta de custódia.
`onboarding`	`object`	Dados de cadastro do titular.
`onboarding.id`	`string`	Identificador do onboarding.
`onboarding.birthDate`	`string`	Data de nascimento.
`onboarding.documentNumber`	`string`	CPF ou CNPJ do titular.
`onboarding.email`	`string`	E-mail do titular.
`onboarding.motherName`	`string`	Nome da mãe.
`onboarding.registerName`	`string`	Nome completo ou razão social.
`onboarding.socialName`	`string`	Nome social ou fantasia.
`onboarding.phone`	`string`	Telefone de contato.
`onboarding.type_account`	`string`	Tipo de conta (PF/PJ).
`onboarding.deletedAt`	`string`	Data de exclusão do cadastro.
`onboarding.occupation`	`string`	Profissão declarada.
`onboarding.pep`	`string`	Informação sobre PEP.
`onboarding.declaredIncome`	`number`	Renda declarada.
`onboarding.assertedIncome`	`number`	Renda validada.
`onboarding.nationality`	`string`	Nacionalidade do titular.
`onboarding.gender`	`string`	Gênero.
`onboarding.relationshipStatus`	`string`	Estado civil.
`onboarding.education`	`string`	Grau de escolaridade.
`onboarding.deviceModel`	`string`	Modelo do dispositivo.
`onboarding.company`	`array`	Lista de empresas associadas.
`onboarding.address`	`object`	Endereço do titular.
`onboarding.address.zipCode`	`string`	CEP.
`onboarding.address.addressLine`	`string`	Logradouro.
`onboarding.address.buildingNumber`	`string`	Número do imóvel.
`onboarding.address.neighborhood`	`string`	Bairro.
`onboarding.address.city`	`string`	Cidade.
`onboarding.address.state`	`string`	Estado.
`onboarding.token[]`	`array`	Lista de documentos enviados.
`onboarding.token.id`	`string`	Identificador do arquivo.
`onboarding.token.content`	`string`	Conteúdo codificado do arquivo.
`onboarding.token.fileName`	`string`	Nome do arquivo.
`onboarding.token.type`	`string`	Tipo do documento (SELFIE, FRONT, BACK).
`onboarding.token.analysisRequestCount`	`number`	Número de análises solicitadas.
`onboarding.token.status`	`string`	Status da análise do documento.
`onboarding.token.createdAt`	`string`	Data de criação do token.
`onboarding.token.updatedAt`	`string`	Data de atualização.
`onboarding.token.deletedAt`	`string`	Data de exclusão.
`onboarding.pfOwner`	`object`	Dados do titular pessoa física.
`onboarding.pjCounterparts[]`	`array`	Dados de empresas vinculadas (PJ).
`onboarding.authBlocked[]`	`array`	Registros de bloqueio de autenticação.
`onboarding.isBlocked`	`boolean`	Indica se o usuário está bloqueado.
`onboarding.isBlockedForRiskAnalysis`	`boolean`	Indica bloqueio por análise de risco.
`agencies`	`object`	Dados da agência vinculada.
`agencies.id`	`string`	Identificador da agência.
`agencies.agency_name`	`string`	Nome da agência.
`agencies.branch`	`string`	Código da agência.
`cards[]`	`array`	Lista de cartões associados à conta.
`cards.id`	`string`	Identificador do cartão.
`cards.cardName`	`string`	Nome impresso no cartão.
`cards.alias`	`string`	Nome alternativo do cartão.
`cards.cardType`	`string`	Tipo do cartão (Virtual, Físico).
`cards.trackingCode`	`string`	Código de rastreamento do cartão físico.
`cards.proxy`	`string`	Proxy vinculado ao cartão.
`cards.activateCode`	`string`	Código de ativação.
`cards.lastFourDigits`	`string`	Últimos quatro dígitos do cartão.
`cards.status`	`string`	Status atual do cartão.
`cards.allowContactless`	`string`	Indica se permite aproximação.
`cards.isActivated`	`boolean`	Indica se está ativado.
`cards.isLocked`	`boolean`	Indica se está bloqueado.
`cards.isCanceled`	`boolean`	Indica se foi cancelado.
`cards.isBuilding`	`boolean`	Indica se está em criação.
`cards.isFirtual`	`boolean`	Indica erro de digitação (possivelmente "isVirtual").
`cards.isPre`	`boolean`	Indica se é pré-pago.
`cards.isPos`	`boolean`	Indica se é pós-pago.
`cards.isDebit`	`boolean`	Indica se é débito.
`cards.paymentDay`	`number`	Dia de pagamento.
`cards.createdAt`	`string`	Data de criação.
`cards.updatedAt`	`string`	Data de atualização.
`cards.deletedAt`	`string`	Data de exclusão.
`cards.batchId`	`string`	Identificador do lote.
`cards.category`	`string`	Categoria do cartão.
`cards.blockedByEscrowActivation`	`boolean`	Indica bloqueio por ativação de custódia.
`plan`	`object`	Informações sobre o plano da conta.
`plan.id`	`string`	Identificador do plano.
`plan.name`	`string`	Nome do plano.
`balance`	`number`	Saldo atual da conta.

{
    "id": "bf1aa555-df16-48bd-a7c0-263cfaa71fb4",
    "status": "Ativa",
    "number": "1101263307",
    "createdAt": "17/11/2023",
    "type": "MAIN",
    "escrowAccountTermsOfUse": null,
    "onboarding": {
        "id": "32873e97-0d58-49f7-a6bb-1da5a7aad3ff",
        "birthDate": "13/07/1997",
        "documentNumber": "10070122695",
        "email": "[email protected]",
        "motherName": "Beatriz Souza",
        "registerName": "Patrícia Nascimento Martins",
        "socialName": "Patrícia Nascimento",
        "phone": "5551913663521",
        "type_account": "PF",
        "deletedAt": null,
        "occupation": "Chefe de Cozinha",
        "pep": "Tenho contato com pessoas politicamente expostas.",
        "declaredIncome": null,
        "assertedIncome": 70314.81,
        "nationality": "Brasileiro",
        "gender": "Feminino",
        "relationshipStatus": "União Estável",
        "education": "ENSINO_FUNDAMENTAL_COMPLETO",
        "deviceModel": "23021RAAEG",
        "company": [],
        "address": {
            "zipCode": "40140210",
            "addressLine": "Rua Dr. Arthur Neiva",
            "buildingNumber": "76",
            "neighborhood": "Barra",
            "city": "Salvador",
            "state": "BA"
        },
        "token": [
            {
                "id": "1690d3a7-2639-45f4-aca3-cef5c8be3efc",
                "content": "63MeSIolPRtojg9eTqV0UJMU8XvWOhrE",
                "fileName": "3dcfcef5-2d85-44ea-aac9-cb5ce628984b.jpg",
                "type": "SELFIE",
                "analysisRequestCount": 2,
                "status": "NO_LIVENESS",
                "createdAt": "2025-09-26T14:21:42.212Z",
                "updatedAt": "2025-09-26T14:21:52.000Z",
                "deletedAt": null
            },
            {
                "id": "4a4e1396-1f16-43a9-b42d-30e6e8183f10",
                "content": "rdurf94gjIbK26_Q4oZX9.xF3_pKHpuW",
                "fileName": "b61f031f-9aa1-40d9-96fd-5e4583dde6ae.jpg",
                "type": "FRONT",
                "analysisRequestCount": 1,
                "status": "UNMATCHED_DOCUMENT",
                "createdAt": "2025-09-26T14:23:33.039Z",
                "updatedAt": "2025-09-26T14:23:35.000Z",
                "deletedAt": null
            },
            {
                "id": "f710f7b7-caf0-4ca2-8ac2-e3a506e2d964",
                "content": "s3Xh2CSJ3BWmR3yMSJ_M_qt08b1d0Hp3",
                "fileName": "24aa2cfd-38fe-4311-9a89-094ea6366fb3.jpg",
                "type": "BACK",
                "analysisRequestCount": 1,
                "status": "NO_DOCUMENT_FOUND",
                "createdAt": "2025-09-26T14:24:23.853Z",
                "updatedAt": "2025-09-26T14:24:25.000Z",
                "deletedAt": null
            }
        ],
        "pfOwner": null,
        "pjCounterparts": [
            {
                "id": "f53c3923-33c4-40b1-a2c1-626c9eaeff7b",
                "birthDate": "2000-09-23",
                "dateNumberDocumentPhoto": "2024-01-24T03:00:00.000Z",
                "documentNumber": "43375050989702",
                "documentNumberPhoto": "n/a",
                "email": "[email protected]",
                "motherName": "n/a",
                "registerName": "Empresa MEI",
                "socialName": "Empresa",
                "status": "APPROVED",
                "reasons": null,
                "hasBrazilianNationality": true,
                "phone": "5571982359698",
                "isPoliticallyExposedPerson": false,
                "type_account": "PJ",
                "retry_onboarding": 0,
                "declaredAnnualBilling": null,
                "createdAt": "2025-08-20T15:30:50.205Z",
                "updatedAt": "2025-09-15T17:20:40.018Z",
                "deletedAt": null,
                "passwordUpdatedAt": null,
                "isImported": false,
                "occupation": null,
                "pep": null,
                "declaredIncome": null,
                "assertedIncome": null,
                "nationality": null,
                "gender": null,
                "relationshipStatus": null,
                "education": null,
                "documentType": null,
                "expirationDateForgotPassword": null,
                "issuerEntity": null,
                "ccbPersonId": null,
                "deviceFCMToken": null,
                "mfaSecret": null,
                "deviceModel": "22101316G",
                "importStatus": null
            }
        ],
        "authBlocked": [
            {
                "id": "a7c3c35a-9816-4adc-b410-494859bc57c0",
                "correlationId": "e08610bd-70fe-430c-a07e-4bd7899d0eb7",
                "type": "FAILED_LOGIN_ATTEMPTS",
                "reason": "Account blocked due to invalid login attempts.",
                "createdAt": "2025-08-22T16:17:20.000Z",
                "updatedAt": "2025-09-09T17:46:16.000Z",
                "deletedAt": "2025-09-09T17:46:16.000Z"
            },
            {
                "id": "a1edecda-b75e-4e0a-9d78-776ff2582eca",
                "correlationId": "d2572241-9099-43d7-8a76-b88dfdefe82c",
                "type": "FAILED_LOGIN_ATTEMPTS",
                "reason": "Account blocked due to invalid login attempts.",
                "createdAt": "2025-10-28T01:21:27.000Z",
                "updatedAt": "2025-10-28T12:46:56.000Z",
                "deletedAt": "2025-10-28T12:46:56.000Z"
            }
        ],
        "isBlocked": false,
        "isBlockedForRiskAnalysis": false
    },
    "agencies": {
        "id": "662024ca-af4d-47f1-8c7e-895187336f1c",
        "agency_name": "Teste Mensageria",
        "branch": "1011"
    },
    "cards": [
        {
            "id": "350fb1cb-eec5-48e8-a08f-19b1d6378ed4",
            "cardName": "Marcos Galvao",
            "alias": "teste cartao",
            "cardType": "Virtual",
            "trackingCode": null,
            "proxy": "7912821000000175184",
            "activateCode": "7BE0C0E8A8B9",
            "lastFourDigits": "1929",
            "status": "Bloqueado",
            "allowContactless": "1",
            "isActivated": true,
            "isLocked": false,
            "isCanceled": false,
            "isBuilding": false,
            "isFirtual": false,
            "isPre": true,
            "isPos": false,
            "isDebit": false,
            "paymentDay": 1,
            "createdAt": "19/09/2024",
            "updatedAt": "2025-01-02T14:38:40.000Z",
            "deletedAt": null,
            "batchId": null,
            "category": "PREPAID_CREDIT",
            "blockedByEscrowActivation": false
        },
        {
            "id": "4442b623-3be7-4f94-a6a2-586999ed51cb",
            "cardName": "Marcos Galvao",
            "alias": "alias",
            "cardType": "Físico",
            "trackingCode": null,
            "proxy": "5125911000000131809",
            "activateCode": "7653DFC4AAD2",
            "lastFourDigits": "----",
            "status": "Processando",
            "allowContactless": "1",
            "isActivated": false,
            "isLocked": false,
            "isCanceled": false,
            "isBuilding": true,
            "isFirtual": false,
            "isPre": true,
            "isPos": false,
            "isDebit": false,
            "paymentDay": 1,
            "createdAt": "28/05/2024",
            "updatedAt": "2025-10-14T00:37:50.000Z",
            "deletedAt": null,
            "batchId": null,
            "category": "PREPAID_CREDIT",
            "blockedByEscrowActivation": false
        }
    ],
    "plan": {
        "id": "6b41e0a7-58d0-4884-9dfb-6886208cbd4b",
        "name": "HIPERBANCO FRANQUIAS LTDA (HIPER BANCO)"
    },
    "balance": 1494.34
}

{
   "id": "4111de70-b5c1-47a8-87d2-ae8c0baa8d14",
   "status": "Ativa",
   "number": "1105166616",
   "createdAt": "23/10/2025",
   "type": "MAIN",
   "escrowAccountTermsOfUse": null,
   "onboarding": {
      "id": "5f160c7d-3582-40ea-84fe-14a9ff88377d",
      "birthDate": "26/03/1995",
      "documentNumber": "32219990130272",
      "email": "[email protected]",
      "motherName": "n/a",
      "registerName": "Next Enterprises LTDA",
      "socialName": "Next Enterprises",
      "phone": "5511917014971",
      "type_account": "PJ",
      "deletedAt": null,
      "occupation": null,
      "pep": null,
      "declaredIncome": null,
      "assertedIncome": null,
      "nationality": null,
      "gender": null,
      "relationshipStatus": null,
      "education": null,
      "deviceModel": null,
      "company": [
         {
            "id": "dfec775c-5f4c-4161-966f-9991961d35b7",
            "businessName": "Next Enterprises LTDA",
            "tradingName": "Next Enterprises",
            "businessEmail": "[email protected]",
            "businessType": "LTDA",
            "legalNature": "206-2",
            "businessSize": "LARGE",
            "documentNumber": "32219990130272",
            "cnaeCode": "8622101",
            "legalrepresentativeId": "1bbe142f-a6eb-4594-ad4b-8285c34e63d5",
            "openingDate": "2024-05-09T03:00:00.000Z",
            "createdAt": "2025-10-23T20:06:04.867Z",
            "updatedAt": "2025-10-23T20:06:04.867Z",
            "deletedAt": null,
            "documentation": {
               "id": "7fef20a9-ce0a-4a38-b233-f70339fd7acc",
               "articlesOfIncorporation": "_PJsRNt1Oj5Z..pDbwmINXW62p8Nshbd",
               "lastContractChange": "wO0avLj.gjzeAaWCeRvamHY0HZ_Au8Fg",
               "balanceSheet": "wO0avLj.gjzeAbWCeRvamHY0HZ_Au8Fg",
               "powerOfAttorney": null,
               "createdAt": "2025-10-23T20:06:04.850Z",
               "updatedAt": "2025-10-23T20:06:04.850Z",
               "deletedAt": null
            },
            "legalRepresentatives": [
               {
                  "id": "1bbe142f-a6eb-4594-ad4b-8285c34e63d5",
                  "gender": null,
                  "relationshipStatus": null,
                  "declaredIncome": null,
                  "nationality": null,
                  "documentNumber": "97135611209",
                  "education": null,
                  "occupation": "OCP0007",
                  "registerName": "Nicole Fátima da Cunhão",
                  "socialName": "Nicole Fátima da Cunhão",
                  "phone": "5571999999999",
                  "birthDate": "1995-03-26",
                  "motherName": "Eloá Ester Cunhão",
                  "email": "[email protected]",
                  "isPoliticallyExposedPerson": false,
                  "participationPercentage": null,
                  "tradingName": null,
                  "businessName": null,
                  "businessType": null,
                  "declaredAnnualBilling": null
               }
            ],
            "owners": [
               {
                  "id": "05af8694-5b5a-41cd-9a06-c5acd339dca1",
                  "gender": "FEMININO",
                  "relationshipStatus": "CASADO",
                  "nationality": "BRASILEIRO",
                  "documentNumber": "97135611209",
                  "education": "Não alfabetizado",
                  "occupation": "Analista e Desenvolvedor de Sistemas",
                  "registerName": "Nicole Fátima da Cunhão",
                  "socialName": "Nicole Fátima da Cunhão",
                  "phone": "5571999999999",
                  "birthDate": "1964-05-09",
                  "motherName": "Eloá Ester",
                  "email": "[email protected]",
                  "isPoliticallyExposedPerson": false,
                  "participationPercentage": "100.00",
                  "tradingName": null,
                  "businessName": null,
                  "businessType": null,
                  "declaredAnnualBilling": null
               },
               {
                  "id": "1bbe142f-a6eb-4594-ad4b-8285c34e63d5",
                  "gender": null,
                  "relationshipStatus": null,
                  "nationality": null,
                  "documentNumber": "97135611209",
                  "occupation": "Analista e Desenvolvedor de Sistemas",
                  "registerName": "Nicole Fátima da Cunhão",
                  "socialName": "Nicole Fátima da Cunhão",
                  "phone": "5571999999999",
                  "birthDate": "1995-03-26",
                  "motherName": "Eloá Ester Cunhão",
                  "email": "[email protected]",
                  "isPoliticallyExposedPerson": false,
                  "participationPercentage": null,
                  "tradingName": null,
                  "businessName": null,
                  "businessType": null,
                  "declaredAnnualBilling": null
               }
            ],
            "legalrepresentative": {
               "id": "1bbe142f-a6eb-4594-ad4b-8285c34e63d5",
               "gender": null,
               "relationshipStatus": null,
               "declaredIncome": null,
               "nationality": null,
               "documentNumber": "97135611209",
               "education": null,
               "occupation": "OCP0007",
               "registerName": "Nicole Fátima da Cunhão",
               "socialName": "Nicole Fátima da Cunhão",
               "phone": "5571999999999",
               "birthDate": "1995-03-26",
               "motherName": "Eloá Ester Cunhão",
               "email": "[email protected]",
               "isPoliticallyExposedPerson": false,
               "participationPercentage": null,
               "tradingName": null,
               "businessName": null,
               "businessType": null,
               "declaredAnnualBilling": null
            }
         }
      ],
      "address": {
         "zipCode": "64000010",
         "addressLine": "Avenida Maranhão",
         "buildingNumber": "601",
         "neighborhood": "Centro",
         "city": "Teresina",
         "state": "PI"
      },
      "token": [],
      "pfOwner": null,
      "pjCounterparts": [],
      "authBlocked": [
         {
            "id": "a7c3c35a-9816-4adc-b410-494859bc57c0",
            "correlationId": "e08610bd-70fe-430c-a07e-4bd7899d0eb7",
            "type": "FAILED_LOGIN_ATTEMPTS",
            "reason": "Account blocked due to invalid login attempts.",
            "createdAt": "2025-08-22T16:17:20.000Z",
            "updatedAt": "2025-09-09T17:46:16.000Z",
            "deletedAt": "2025-09-09T17:46:16.000Z"
         },
         {
            "id": "a1edecda-b75e-4e0a-9d78-776ff2582eca",
            "correlationId": "d2572241-9099-43d7-8a76-b88dfdefe82c",
            "type": "FAILED_LOGIN_ATTEMPTS",
            "reason": "Account blocked due to invalid login attempts.",
            "createdAt": "2025-10-28T01:21:27.000Z",
            "updatedAt": "2025-10-28T12:46:56.000Z",
            "deletedAt": "2025-10-28T12:46:56.000Z"
         }
      ],
      "isBlocked": false,
      "isBlockedForRiskAnalysis": false
   },
   "agencies": {
      "id": "244fd003-04f3-45ce-a8aa-4d41cd152199",
      "agency_name": "Agência Padrão",
      "branch": "0001"
   },
   "cards": [
      {
         "id": "350fb1cb-eec5-48e8-a08f-19b1d6378ed4",
         "cardName": "Marcos Galvao",
         "alias": "teste cartao",
         "cardType": "Virtual",
         "trackingCode": null,
         "proxy": "7912821000000175184",
         "activateCode": "7BE0C0E8A8B9",
         "lastFourDigits": "1929",
         "status": "Bloqueado",
         "allowContactless": "1",
         "isActivated": true,
         "isLocked": false,
         "isCanceled": false,
         "isBuilding": false,
         "isFirtual": false,
         "isPre": true,
         "isPos": false,
         "isDebit": false,
         "paymentDay": 1,
         "createdAt": "19/09/2024",
         "updatedAt": "2025-01-02T14:38:40.000Z",
         "deletedAt": null,
         "batchId": null,
         "category": "PREPAID_CREDIT",
         "blockedByEscrowActivation": false
      },
      {
         "id": "4442b623-3be7-4f94-a6a2-586999ed51cb",
         "cardName": "Marcos Galvao",
         "alias": "alias",
         "cardType": "Físico",
         "trackingCode": null,
         "proxy": "5125911000000131809",
         "activateCode": "7653DFC4AAD2",
         "lastFourDigits": "----",
         "status": "Processando",
         "allowContactless": "1",
         "isActivated": false,
         "isLocked": false,
         "isCanceled": false,
         "isBuilding": true,
         "isFirtual": false,
         "isPre": true,
         "isPos": false,
         "isDebit": false,
         "paymentDay": 1,
         "createdAt": "28/05/2024",
         "updatedAt": "2025-10-14T00:37:50.000Z",
         "deletedAt": null,
         "batchId": null,
         "category": "PREPAID_CREDIT",
         "blockedByEscrowActivation": false
      }
   ],
   "plan": {
      "id": "016781a6-ae29-11f0-a6a4-42010af9fa02",
      "name": "Plano Padrão PJ"
   },
   "balance": 0
}

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.