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

# People & Organizations

> Reference the people and organization fields used across Lerian APIs — personal data, corporate data, contacts, addresses, and identity.

This page groups all fields related to personal data, corporate data, contact details, addresses, and identity management.

## 1. Personal and business information

***

| Field        | Description                    | Used in                                 |
| ------------ | ------------------------------ | --------------------------------------- |
| name         | Full name or legal entity name | Midaz, CRM, Pix, Flowker, Identity      |
| document     | Tax ID (CPF/CNPJ)              | CRM, Pix                                |
| type         | Person type or resource type   | CRM, Pix, Flowker                       |
| favoriteName | Preferred or nickname          | CRM                                     |
| socialName   | Social name                    | CRM                                     |
| tradeName    | Trade name                     | CRM, Pix                                |
| motherName   | Mother's name                  | CRM, Pix                                |
| fatherName   | Father's name                  | CRM                                     |
| gender       | Gender                         | CRM, Identity                           |
| civilStatus  | Civil status                   | CRM                                     |
| nationality  | Nationality                    | CRM                                     |
| activity     | Business activity              | CRM                                     |
| size         | Company size                   | CRM                                     |
| status       | Status (active, inactive, etc) | Midaz, CRM, Pix, Fee, Flowker, Identity |

## 2. Contact information

***

| Field          | Description             | Used in             |
| -------------- | ----------------------- | ------------------- |
| email          | Primary email           | Auth, CRM, Identity |
| primaryEmail   | Primary email           | CRM, Identity       |
| secondaryEmail | Secondary email         | CRM, Identity       |
| emailVerified  | Email verification flag | Auth, Identity      |
| mobilePhone    | Mobile phone            | CRM, Identity       |
| otherPhone     | Additional phone        | CRM                 |
| phone          | Main phone              | Midaz, Identity     |

## 3. Addresses

***

| Field       | Description                     | Used in         |
| ----------- | ------------------------------- | --------------- |
| address     | Full address or nested object   | Midaz, Identity |
| line1       | Address line 1                  | CRM             |
| line2       | Address line 2                  | CRM             |
| zipCode     | ZIP code                        | CRM             |
| city        | City                            | CRM             |
| state       | State                           | CRM             |
| country     | ISO 3166-1 alpha-2 country code | CRM             |
| countryCode | Country bank code               | CRM             |
| description | Address description             | CRM             |

## 4. Organizational structures (Midaz)

***

| Field                | Description                    | Used in |
| -------------------- | ------------------------------ | ------- |
| legalName            | Legal company name             | Midaz   |
| doingBusinessAs      | Trade name                     | Midaz   |
| legalDocument        | Official legal document        | Midaz   |
| address              | Organization address           | Midaz   |
| phone                | Main phone                     | Midaz   |
| website              | Website                        | Midaz   |
| parentOrganizationId | Parent organization identifier | Midaz   |
| metadata             | Flexible key-value metadata    | Midaz   |
| scale                | Scale factor for calculations  | Midaz   |
| precision            | Decimal precision              | Midaz   |
| symbol               | Currency or asset symbol       | Midaz   |
| balance              | Account balance                | Midaz   |
| available            | Available balance              | Midaz   |
| onHold               | Held balance                   | Midaz   |

## 5. User profile

***

| Field             | Description          | Used in        |
| ----------------- | -------------------- | -------------- |
| profile           | User profile URL     | Auth, Identity |
| preferredUsername | Preferred username   | Auth, Identity |
| picture           | Profile picture URL  | Auth, Identity |
| avatar            | Avatar image URL     | Identity       |
| bio               | User biography       | Identity       |
| locale            | Preferred locale     | Identity       |
| timezone          | User timezone        | Identity       |
| representative    | Legal representative | CRM            |
| role              | User role            | CRM, Identity  |

## 6. Identity — users and groups

***

| Field                | Description             | Used in  |
| -------------------- | ----------------------- | -------- |
| userId               | Unique user identifier  | Identity |
| user\_id             | User ID (admin context) | Identity |
| username             | Unique username         | Identity |
| email                | Primary email           | Identity |
| emailVerified        | Email verified flag     | Identity |
| phone                | User phone              | Identity |
| phoneVerified        | Phone verified flag     | Identity |
| password             | Hashed password         | Identity |
| passwordHash         | bcrypt hash             | Identity |
| passwordChangedAt    | Last password change    | Identity |
| passwordResetToken   | Reset token             | Identity |
| passwordResetExpires | Reset expiration        | Identity |
| firstName            | First name              | Identity |
| lastName             | Last name               | Identity |
| fullName             | Full name               | Identity |
| displayName          | Display name            | Identity |
| avatar               | Avatar                  | Identity |
| bio                  | User biography          | Identity |
| locale               | User locale             | Identity |
| timezone             | Timezone                | Identity |
| isActive             | User active flag        | Identity |
| isEmailVerified      | Email verified flag     | Identity |
| isMfaEnabled         | MFA enabled             | Identity |
| mfaSecret            | MFA secret              | Identity |
| lastLoginAt          | Last login              | Identity |
| lastActivityAt       | Last activity           | Identity |
| loginCount           | Login counter           | Identity |
| failedLoginAttempts  | Failed login attempts   | Identity |
| lockedUntil          | Lock expiration         | Identity |
| groupId              | Group ID                | Identity |
| groupName            | Group name              | Identity |
| groupDescription     | Group description       | Identity |
| permissions          | Array of permissions    | Identity |
| roles                | Array of roles          | Identity |
| metadata             | Custom metadata         | Identity |
| createdBy            | Created by user         | Identity |
| updatedBy            | Updated by user         | Identity |
| deletedBy            | Deleted by user         | Identity |
| createdAt            | Creation timestamp      | Identity |
| updatedAt            | Update timestamp        | Identity |
| deletedAt            | Deletion timestamp      | Identity |