Obtendo informações sobre sua conta

Este endpoint permite consultar informações detalhadas sobre a conta associada ao usuário autenticado, incluindo dados pessoais, dados da conta e informações da empresa (WhiteLabel).

📍 Requisição

curl https://api.etherglobalassets.com.br/users/bank-account/details \
  --header 'Authorization: Bearer <token>'

Parâmetros de Cabeçalho (Headers)

Campo

Obrigatório

Descrição

Authorization

Token de acesso no formato Bearer <token>.

✅ Respostas Possíveis

200 - Sucesso

Retorna os dados completos do usuário e da conta bancária.

{
  "user": {
    "id": "511d7f32-f723-4665-809f-6def95f4d5c2",
    "email": "naudo@email.com.br",
    "name": "Naudo Silva",
    "role": "ADMIN",
    "cognitoId": "naudo@email.com.br",
    "tenantId": "fcse242-40d0-4d1a-a431-40jjjjjjjjjj",
    "managerId": null,
    "baasId": null,
    "paymentId": null,
    "status": "active",
    "createdAt": "2025-03-24T14:42:02.342Z",
    "updatedAt": "2025-03-24T14:43:43.737Z",
    "userProfiles": [
      {
        "id": "7c234cf3-absd-47f2-9747-acde43b0b3d",
        "userId": "511d7f32-a723-4665-809f-6def22e4d5c2",
        "passportNumber": null,
        "nationality": null,
        "taxId": "098.878.877-99",
        "phone": "(98) 99999-9999",
        "cellphone": "(98) 99999-9999",
        "socialName": "",
        "dateBirth": "2000-09-08T00:00:00.000Z",
        "motherName": null,
        "fatherName": null,
        "gender": null,
        "monthlyIncome": "20.000,00",
        "assessment": "",
        "cnaeId": "",
        "legalNature": "",
        "maritalStatus": null,
        "document": "09887887799",
        "hometown": null,
        "personType": "FISICA"
      }
    ],
    "tenant": {
      "id": "fc762427-40d0-4d1a-a431-40aa29109067",
      "name": "Ether - Teste",
      "email": "tocipiy804@apklamp.com",
      "contact": "Novo contato",
      "taxId": "000000000000",
      "phone": "+5511999900000",
      "monthlyFee": 4000,
      "paymentDate": "2024-03-24T00:00:00.000Z",
      "status": "active",
      "url": "banking-sandbox.etherglobalassets.com.br",
      "maintenanceMode": false,
      "createdAt": "2025-02-27T17:09:39.899Z",
      "updatedAt": "2025-03-25T17:13:16.156Z"
    },
    "profile": null
  },
  "bankAccount": {
    "id": "5a8384d1-71b9-4586-9068-3fa41547f8eb",
    "userId": "511d7f32-f723-4665-809f-6def95f4d5c2",
    "bankName": "Ether - Teste",
    "agencyNumber": "0001",
    "accountNumber": "99999999",
    "tenantId": "fc762427-40d0-4d1a-a431-409999999999",
    "pixKey": null,
    "createdAt": "2025-03-24T14:44:20.721Z",
    "updatedAt": "2025-03-24T14:44:20.721Z"
  }
}

❌ Erros Comuns

Código

Status

Descrição

400

Validação Falhou

Erros na requisição (ex.: token malformado).

401

Acesso Não Autorizado

Token inválido, expirado ou ausente.

403

Acesso Proibido

Usuário não tem permissão para acessar este recurso.

500

Erro Interno do Servidor

Falha inesperada no sistema.

🔍 Campos Destacados na Resposta

👤 Dados do Usuário (user)

  • name/email: Dados básicos de contato.

  • taxId/phone: Dados de identificação e comunicação.

  • status: Situação cadastral (active, inactive).

  • monthlyIncome/personType: Perfil financeiro e tipo de pessoa (FISICA/JURIDICA).

🏦 Dados da Conta Bancária (bankAccount)

  • bankName: Instituição bancária parceira.

  • agencyNumber/accountNumber: Dados para movimentações internas.

🏢 Dados da Empresa (tenant)

  • name/taxId: Nome comercial e CNPJ da WhiteLabel.

  • status/url: Disponibilidade do ambiente e domínio associado.

🚀 Exemplo de Uso Prático

  1. Autentique-se para obter o Access Token.

  2. Envie a requisição com o token no cabeçalho Authorization.

  3. Armazene os dados para exibição no seu dashboard ou integração via API.

[!TIP] Segurança: Utilize máscaras (ex: ***.***.877-99) no frontend para exibir dados sensíveis como taxId e accountNumber.