> ## 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.

# Personas y organizaciones

> Referencia de los campos de personas y organizaciones usados en las APIs de Lerian: datos personales, datos corporativos, contactos, direcciones e identidad.

Esta página agrupa todos los campos relacionados con los datos personales, los datos corporativos, los datos de contacto, las direcciones y la gestión de identidad.

## 1. Información personal y empresarial

***

| Campo        | Descripción                       | Usado en                       |
| ------------ | --------------------------------- | ------------------------------ |
| name         | Nombre completo o razón social    | Midaz, CRM, Pix, Identity      |
| document     | Identificación fiscal (CPF/CNPJ)  | CRM, Pix                       |
| type         | Tipo de persona o tipo de recurso | CRM, Pix                       |
| favoriteName | Nombre preferido o apodo          | CRM                            |
| socialName   | Nombre social                     | CRM                            |
| tradeName    | Nombre comercial                  | CRM, Pix                       |
| motherName   | Nombre de la madre                | CRM, Pix                       |
| fatherName   | Nombre del padre                  | CRM                            |
| gender       | Género                            | CRM, Identity                  |
| civilStatus  | Estado civil                      | CRM                            |
| nationality  | Nacionalidad                      | CRM                            |
| activity     | Actividad comercial               | CRM                            |
| size         | Tamaño de la empresa              | CRM                            |
| status       | Estado (activo, inactivo, etc.)   | Midaz, CRM, Pix, Fee, Identity |

## 2. Información de contacto

***

| Campo          | Descripción                                     | Usado en            |
| -------------- | ----------------------------------------------- | ------------------- |
| email          | Correo electrónico principal                    | Auth, CRM, Identity |
| primaryEmail   | Correo electrónico principal                    | CRM, Identity       |
| secondaryEmail | Correo electrónico secundario                   | CRM, Identity       |
| emailVerified  | Indicador de verificación de correo electrónico | Auth, Identity      |
| mobilePhone    | Teléfono móvil                                  | CRM, Identity       |
| otherPhone     | Teléfono adicional                              | CRM                 |
| phone          | Teléfono principal                              | Midaz, Identity     |

## 3. Direcciones

***

| Campo       | Descripción                         | Usado en        |
| ----------- | ----------------------------------- | --------------- |
| address     | Dirección completa u objeto anidado | Midaz, Identity |
| line1       | Línea de dirección 1                | CRM             |
| line2       | Línea de dirección 2                | CRM             |
| zipCode     | Código postal                       | CRM             |
| city        | Ciudad                              | CRM             |
| state       | Estado                              | CRM             |
| country     | Código de país ISO 3166-1 alfa-2    | CRM             |
| countryCode | Código bancario del país            | CRM             |
| description | Descripción de la dirección         | CRM             |

## 4. Estructuras organizacionales (Midaz)

***

| Campo                | Descripción                                | Usado en |
| -------------------- | ------------------------------------------ | -------- |
| legalName            | Razón social                               | Midaz    |
| doingBusinessAs      | Nombre comercial                           | Midaz    |
| legalDocument        | Documento legal oficial                    | Midaz    |
| address              | Dirección de la organización               | Midaz    |
| phone                | Teléfono principal                         | Midaz    |
| website              | Sitio web                                  | Midaz    |
| parentOrganizationId | Identificador de la organización principal | Midaz    |
| metadata             | Metadatos flexibles de clave-valor         | Midaz    |
| scale                | Factor de escala para cálculos             | Midaz    |
| precision            | Precisión decimal                          | Midaz    |
| symbol               | Símbolo de moneda o activo                 | Midaz    |
| balance              | Saldo de la cuenta                         | Midaz    |
| available            | Saldo disponible                           | Midaz    |
| onHold               | Saldo retenido                             | Midaz    |

## 5. Perfil del usuario

***

| Campo             | Descripción                      | Usado en       |
| ----------------- | -------------------------------- | -------------- |
| profile           | URL del perfil del usuario       | Auth, Identity |
| preferredUsername | Nombre de usuario preferido      | Auth, Identity |
| picture           | URL de la foto de perfil         | Auth, Identity |
| avatar            | URL de la imagen de avatar       | Identity       |
| bio               | Biografía del usuario            | Identity       |
| locale            | Configuración regional preferida | Identity       |
| timezone          | Zona horaria del usuario         | Identity       |
| representative    | Representante legal              | CRM            |
| role              | Rol del usuario                  | CRM, Identity  |

## 6. Identity: usuarios y grupos

***

| Campo                | Descripción                                | Usado en |
| -------------------- | ------------------------------------------ | -------- |
| userId               | Identificador único del usuario            | Identity |
| user\_id             | ID del usuario (contexto de administrador) | Identity |
| username             | Nombre de usuario único                    | Identity |
| email                | Correo electrónico principal               | Identity |
| emailVerified        | Indicador de correo electrónico verificado | Identity |
| phone                | Teléfono del usuario                       | Identity |
| phoneVerified        | Indicador de teléfono verificado           | Identity |
| password             | Contraseña con hash                        | Identity |
| passwordHash         | Hash de bcrypt                             | Identity |
| passwordChangedAt    | Último cambio de contraseña                | Identity |
| passwordResetToken   | Token de restablecimiento                  | Identity |
| passwordResetExpires | Expiración del restablecimiento            | Identity |
| firstName            | Nombre                                     | Identity |
| lastName             | Apellido                                   | Identity |
| fullName             | Nombre completo                            | Identity |
| displayName          | Nombre para mostrar                        | Identity |
| avatar               | Avatar                                     | Identity |
| bio                  | Biografía del usuario                      | Identity |
| locale               | Configuración regional del usuario         | Identity |
| timezone             | Zona horaria                               | Identity |
| isActive             | Indicador de usuario activo                | Identity |
| isEmailVerified      | Indicador de correo electrónico verificado | Identity |
| isMfaEnabled         | MFA habilitado                             | Identity |
| mfaSecret            | Secreto de MFA                             | Identity |
| lastLoginAt          | Último inicio de sesión                    | Identity |
| lastActivityAt       | Última actividad                           | Identity |
| loginCount           | Contador de inicios de sesión              | Identity |
| failedLoginAttempts  | Intentos de inicio de sesión fallidos      | Identity |
| lockedUntil          | Expiración del bloqueo                     | Identity |
| groupId              | ID del grupo                               | Identity |
| groupName            | Nombre del grupo                           | Identity |
| groupDescription     | Descripción del grupo                      | Identity |
| permissions          | Arreglo de permisos                        | Identity |
| roles                | Arreglo de roles                           | Identity |
| metadata             | Metadatos personalizados                   | Identity |
| createdBy            | Creado por el usuario                      | Identity |
| updatedBy            | Actualizado por el usuario                 | Identity |
| deletedBy            | Eliminado por el usuario                   | Identity |
| createdAt            | Marca de tiempo de creación                | Identity |
| updatedAt            | Marca de tiempo de actualización           | Identity |
| deletedAt            | Marca de tiempo de eliminación             | Identity |