Guides/GuiasReferência APICryptoBrokers

Obtendo informações sobre o perfil do usuário​

Este endpoint permite consultar informações detalhadas sobre o perfil de um usuário específico, incluindo dados pessoais, dados da conta e informações da empresa (tenant) associada.

Requisição 

curl 'https://api.etherglobalassets.com.br/users/account/profile/{userId}' \
  --header 'Authorization: Bearer <token>'

Parâmetros:

  • Path Parameter

    • userId (string): ID único do usuário cujo perfil será consultado.

  • Header

    • Authorization: Token de acesso no formato Bearer <token>.

Respostas Possíveis

✅ 200 - Sucesso
Retorna os dados completos do usuário e seu perfil associado.

{
  "user": {
    "id": "511d7f32-f723-4665-809f-fff000000000",
    "email": "naudo@email.com.br",
    "name": "Naudo Silva",
    "role": "ADMIN",
    "cognitoId": "naudo@email.com.br",
    "tenantId": "fcse242-40d0-4d1a-a431-000000000000",
    "managerId": null,
    "baasId": null,
    "paymentId": null,
    "status": "active",
    "createdAt": "2025-03-24T14:42:02.342Z",
    "updatedAt": "2025-03-24T14:43:43.737Z",
    "tenant": {
      "id": "fcse242-40d0-4d1a-a431-000000000000",
      "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
  },
  "profile": {
    "id": "7c460cf3-378d-47f2-9747-000000000000",
    "userId": "511d7f32-f723-4665-809f-fff000000000",
    "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"
  }
}

❌ 400 - Validação Falhou
Erros na requisição (ex.:

userId

inválido ou malformado).

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    "Validation error 1",
    "Validation error 2"
  ]
}

🔒 401 - Acesso Não Autorizado
Token inválido, expirado ou ausente.

{
  "success": false,
  "message": "Unauthorized access"
}

🚫 403 - Acesso Proibido
Usuário não tem permissão para acessar este recurso.

{
  "success": false,
  "message": "Forbidden"
}

⚠️ 500 - Erro Interno do Servidor
Falha inesperada no sistema.

{
  "success": false,
  "message": "Internal server error"
}

Campos Destacados na Resposta 200

  • Dados do Usuário (user):

    • Informações básicas (name, email, role).

    • Status da conta (status) e datas de criação/atualização.

    • Dados da empresa associada (tenant), como nome, CNPJ e plano.

  • Perfil do Usuário (profile):

    • Dados pessoais (taxId, phone, dateBirth).

    • Informações financeiras (monthlyIncome, personType).

    • Detalhes documentais (document, socialName).

Exemplo de Uso Prático

  1. Autentique-se para obter o Access Token.

  2. Substitua {userId} pelo ID do usuário alvo.

  3. Envie a requisição e trate a resposta conforme o status:

    • Se 200, exiba os dados ou armazene para uso futuro.

    • Se 403, verifique as permissões do token.

Dicas:

  • Para endpoints sensíveis, registre em logs acessos a userId específicos.

  • Use máscaras para campos como taxId ou phone no frontend.

Exemplo em JavaScript (opcional):

fetch('https://api.etherglobalassets.com.br/users/account/profile/511d7f32-f723-4665-809f-fff000000000', {
  headers: {
    'Authorization': 'Bearer <token>'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Observação:

  • O campo profile será null se o perfil não estiver cadastrado.

  • Para erros 400, verifique se o userId está no formato UUID.

Mais informações sobre o endpoint:

Acesse aqui