> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Pessoas e organizações

> Consulte os campos de pessoas e organizações usados nas APIs da Lerian: dados pessoais, dados corporativos, contatos, endereços e identidade.

Esta página agrupa todos os campos relacionados a dados pessoais, dados corporativos, detalhes de contato, endereços e gestão de identidade.

## 1. Informações pessoais e empresariais

***

| Campo        | Descrição                         | Usado em                       |
| ------------ | --------------------------------- | ------------------------------ |
| name         | Nome completo ou razão social     | Midaz, CRM, Pix, Identity      |
| document     | CPF/CNPJ                          | CRM, Pix                       |
| type         | Tipo de pessoa ou tipo de recurso | CRM, Pix                       |
| favoriteName | Nome preferido ou apelido         | CRM                            |
| socialName   | Nome social                       | CRM                            |
| tradeName    | Nome fantasia                     | CRM, Pix                       |
| motherName   | Nome da mãe                       | CRM, Pix                       |
| fatherName   | Nome do pai                       | CRM                            |
| gender       | Gênero                            | CRM, Identity                  |
| civilStatus  | Estado civil                      | CRM                            |
| nationality  | Nacionalidade                     | CRM                            |
| activity     | Atividade empresarial             | CRM                            |
| size         | Porte da empresa                  | CRM                            |
| status       | Status (ativo, inativo, etc.)     | Midaz, CRM, Pix, Fee, Identity |

## 2. Informações de contato

***

| Campo          | Descrição                            | Usado em            |
| -------------- | ------------------------------------ | ------------------- |
| email          | E-mail principal                     | Auth, CRM, Identity |
| primaryEmail   | E-mail principal                     | CRM, Identity       |
| secondaryEmail | E-mail secundário                    | CRM, Identity       |
| emailVerified  | Sinalizador de verificação de e-mail | Auth, Identity      |
| mobilePhone    | Celular                              | CRM, Identity       |
| otherPhone     | Telefone adicional                   | CRM                 |
| phone          | Telefone principal                   | Midaz, Identity     |

## 3. Endereços

***

| Campo       | Descrição                            | Usado em        |
| ----------- | ------------------------------------ | --------------- |
| address     | Endereço completo ou objeto aninhado | Midaz, Identity |
| line1       | Linha de endereço 1                  | CRM             |
| line2       | Linha de endereço 2                  | CRM             |
| zipCode     | CEP                                  | CRM             |
| city        | Cidade                               | CRM             |
| state       | Estado                               | CRM             |
| country     | Código de país ISO 3166-1 alpha-2    | CRM             |
| countryCode | Código bancário do país              | CRM             |
| description | Descrição do endereço                | CRM             |

## 4. Estruturas organizacionais (Midaz)

***

| Campo                | Descrição                          | Usado em |
| -------------------- | ---------------------------------- | -------- |
| legalName            | Razão social                       | Midaz    |
| doingBusinessAs      | Nome fantasia                      | Midaz    |
| legalDocument        | Documento legal oficial            | Midaz    |
| address              | Endereço da organização            | Midaz    |
| phone                | Telefone principal                 | Midaz    |
| website              | Site                               | Midaz    |
| parentOrganizationId | Identificador da organização pai   | Midaz    |
| metadata             | Metadados flexíveis de chave-valor | Midaz    |
| scale                | Fator de escala para cálculos      | Midaz    |
| precision            | Precisão decimal                   | Midaz    |
| symbol               | Símbolo da moeda ou do ativo       | Midaz    |
| balance              | Saldo da conta                     | Midaz    |
| available            | Saldo disponível                   | Midaz    |
| onHold               | Saldo retido                       | Midaz    |

## 5. Perfil do usuário

***

| Campo             | Descrição                 | Usado em       |
| ----------------- | ------------------------- | -------------- |
| profile           | URL do perfil do usuário  | Auth, Identity |
| preferredUsername | Nome de usuário preferido | Auth, Identity |
| picture           | URL da foto de perfil     | Auth, Identity |
| avatar            | URL da imagem do avatar   | Identity       |
| bio               | Biografia do usuário      | Identity       |
| locale            | Localidade preferida      | Identity       |
| timezone          | Fuso horário do usuário   | Identity       |
| representative    | Representante legal       | CRM            |
| role              | Papel do usuário          | CRM, Identity  |

## 6. Identity: usuários e grupos

***

| Campo                | Descrição                               | Usado em |
| -------------------- | --------------------------------------- | -------- |
| userId               | Identificador único do usuário          | Identity |
| user\_id             | ID do usuário (contexto administrativo) | Identity |
| username             | Nome de usuário único                   | Identity |
| email                | E-mail principal                        | Identity |
| emailVerified        | Sinalizador de e-mail verificado        | Identity |
| phone                | Telefone do usuário                     | Identity |
| phoneVerified        | Sinalizador de telefone verificado      | Identity |
| password             | Senha com hash                          | Identity |
| passwordHash         | Hash bcrypt                             | Identity |
| passwordChangedAt    | Última alteração de senha               | Identity |
| passwordResetToken   | Token de redefinição                    | Identity |
| passwordResetExpires | Expiração da redefinição                | Identity |
| firstName            | Primeiro nome                           | Identity |
| lastName             | Sobrenome                               | Identity |
| fullName             | Nome completo                           | Identity |
| displayName          | Nome de exibição                        | Identity |
| avatar               | Avatar                                  | Identity |
| bio                  | Biografia do usuário                    | Identity |
| locale               | Localidade do usuário                   | Identity |
| timezone             | Fuso horário                            | Identity |
| isActive             | Sinalizador de usuário ativo            | Identity |
| isEmailVerified      | Sinalizador de e-mail verificado        | Identity |
| isMfaEnabled         | MFA habilitado                          | Identity |
| mfaSecret            | Segredo do MFA                          | Identity |
| lastLoginAt          | Último login                            | Identity |
| lastActivityAt       | Última atividade                        | Identity |
| loginCount           | Contador de logins                      | Identity |
| failedLoginAttempts  | Tentativas de login malsucedidas        | Identity |
| lockedUntil          | Expiração do bloqueio                   | Identity |
| groupId              | ID do grupo                             | Identity |
| groupName            | Nome do grupo                           | Identity |
| groupDescription     | Descrição do grupo                      | Identity |
| permissions          | Array de permissões                     | Identity |
| roles                | Array de papéis                         | Identity |
| metadata             | Metadados personalizados                | Identity |
| createdBy            | Criado pelo usuário                     | Identity |
| updatedBy            | Atualizado pelo usuário                 | Identity |
| deletedBy            | Excluído pelo usuário                   | Identity |
| createdAt            | Timestamp de criação                    | Identity |
| updatedAt            | Timestamp de atualização                | Identity |
| deletedAt            | Timestamp de exclusão                   | Identity |