Consulta de Perfil — Pessoa Física ou Jurídica

Após a autenticação e obtenção do token JWT, este endpoint permite consultar as informações do usuário ou empresa logada no sistema.

A escolha do endpoint depende do tipo da entidade associada ao token:

Pessoa Física (PERSON): utilize GET /persons
Pessoa Jurídica (COMPANY): utilize GET /companies

O retorno inclui dados como identificação, e-mail, telefone, status de onboarding e demais informações cadastrais vinculadas ao tenant atual.

Estes endpoints são protegidos e requerem o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id

Endpoint para consulta Pessoa Física

GET /persons

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

x-tenant-id

Tenant ID

Response

{
  "person": {
    "id": "4e6f21a3-1a0f-4e4e-99b5-84f3b7b3db4a",
    "email": "[email protected]",
    "emailConfirmation": true,
    "phone": "+5521987654321",
    "phoneConfirmation": true,
    "name": "Mariana Souza Oliveira",
    "document": "32165498700",
    "status": "ACTIVE",
    "onboardingStep": "DONE",
    "hasPin": true
  },
  "individual": {
    "id": "c9c1812a-3b27-4a41-9a31-b8c20b9d9e11",
    "birthDate": "1995-03-21T00:00:00.000Z",
    "motherName": "Luciana Alves Souza",
    "fatherName": "Carlos Eduardo Oliveira",
    "income": 7200,
    "nationality": "BRASILEIRA",
    "publiclyExposedPerson": false,
    "documentType": "CNH",
    "documentNumber": "MG1234567",
    "documentUf": "MG",
    "documentIssuing": "DETRAN",
    "documentDateIssue": "2024-01-15T00:00:00.000Z",
    "documentExpiration": "2034-01-15T00:00:00.000Z"
  },
  "address": {
    "id": "e73a5f4c-b820-4d6d-a6b1-73114e1a9d55",
    "zipCode": "30140071",
    "state": "MG",
    "city": "Belo Horizonte",
    "neighborhood": "Savassi",
    "street": "Rua Antônio de Albuquerque",
    "number": "450",
    "complement": "Apto 702"
  },
  "accounts": [
    {
      "id": "5bce0e91-442d-4b8a-8b6e-72a12de909c8",
      "bank": "290",
      "agency": "0001",
      "number": "19283045",
      "balance": 1850.72,
      "status": "APPROVED",
      "isEscrow": false,
      "investmentAccount": null
    }
  ]
}

{
    "code": "BAD_REQUEST",
    "error": "Tentant não encontrado ou inválido.",
    "message": "Tentant não encontrado ou inválido."
}

{
    "code": "BAD_REQUEST",
    "status": 403,
    "message": "Acesso não autorizado"
}

Endpoint para Pessoa Jurídica

GET /companies