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

# O que é CRM?

> O CRM é a camada opcional que enriquece Contas do Ledger Midaz com perfis de cliente, identidade e contexto de negócio em um só lugar.

O CRM **não faz parte do domínio transacional do ledger**. Ele adiciona atributos de negócio às contas do ledger. Ele não altera a lógica, a consistência nem o desempenho do ledger.

O CRM é onde os metadados do usuário ficam. Ele não guarda saldos, transferências nem taxas. Ele registra quem está por trás de uma conta e o que você precisa saber para operar seu negócio.

## Versionado com o Midaz

***

O CRM é executado dentro do ledger do Midaz e não precisa de **nenhuma licença separada**. O Midaz é source-available.

O CRM compartilha a versão do Midaz. Por exemplo, o Midaz `v3.5.0` usa o CRM `v3.5.0`.

O CRM é executado no mesmo binário que o ledger. Ele está sempre disponível. Você decide se armazena dados de holder e chama os endpoints dele.

<Tip>
  **Teste o CRM localmente**

  Você pode executar o CRM com o stack do Midaz localmente, sem Kubernetes, usando nosso [repositório plugins-docker-compose](https://github.com/LerianStudio/plugins-docker-compose).
</Tip>

## Por que usar o CRM?

***

As contas do ledger do Midaz são genéricas por design. Elas são orientadas a transações e agnósticas ao domínio. O CRM adiciona significado a essas contas e vincula cada uma a um perfil de usuário e a um contexto de negócio.

Você não precisa usar o CRM. Você pode adotá-lo mais tarde, apenas quando seu caso de uso precisa de metadados de cliente ou de negócio além do ledger.

### Exemplos de casos de uso

* **Banking (pessoas físicas e jurídicas)**: O CRM armazena identificadores como CPF ou CNPJ, um endereço, dados de contato ou números de conta. O Midaz executa a mesma lógica de transação para ambos os tipos de cliente.
* **Cadeias de suprimento (fornecedor, fábrica, varejista)**: O CRM rastreia metadados como IDs de fornecedores, localizações de armazéns ou detalhes de contrato. Esses dados não pertencem à transação, mas impulsionam as decisões de negócio.

<Tip>
  O CRM é executado dentro do ledger do Midaz, então não há um serviço separado para implantar. Use-o apenas se o seu produto ou contexto regulatório precisar de metadados de cliente ou de negócio.
</Tip>

## Entidades

***

O CRM tem duas entidades principais:

* **[Holder](/pt/midaz/crm/holders)** – A entidade principal no CRM. Ela representa a persona de uma conta do ledger do Midaz. Ela armazena atributos de identidade e características individuais.
* **[Alias Account](/pt/midaz/crm/alias-accounts)** – O contexto de negócio de uma [Conta do Ledger](/pt/midaz/accounts) no **Midaz Ledger**. Ela contém detalhes financeiros como informações de conta bancária.

A *Figura 1* mostra como as entidades do CRM se conectam ao Midaz.

<Frame caption="Figura 1. Ilustração de como as entidades do CRM se conectam ao Midaz">
  <img src="https://mintcdn.com/lerian-49cb71fc/ZrZBZTM4DWnrahSd/images/pt/d2/entities-new.svg?fit=max&auto=format&n=ZrZBZTM4DWnrahSd&q=85&s=b04b423c28a17d3e0784866ca5b4cb45" alt="Como as entidades de CRM, o Holder e a Alias Account, se conectam às contas do ledger do Midaz" width="1428" height="1114" data-path="images/pt/d2/entities-new.svg" />
</Frame>

## Princípios de design

***

O CRM se concentra em:

* **Separação de responsabilidades**: Mantém os dados de perfil de usuário fora da lógica de transação.
* **Desempenho do sistema**: Não adiciona orquestração a nível de usuário dentro dos serviços core do Midaz.
* **Implantação mais simples**: O CRM é executado dentro do binário do ledger, sem um serviço separado para executar.
* **Limites claros de domínio**: Evolui com o Midaz sem acoplamento aos internos do ledger.

<Danger>
  O CRM não valida regras a nível de ledger nem processos de conformidade como KYC. É uma camada de dados neutra e persistente.
</Danger>

## Comportamento da API

***

O CRM é executado dentro do binário do ledger do Midaz. Ele expõe uma API de registro para dados não transacionais vinculados a contas do Midaz.

* Ele **não** aplica validações como status do usuário, perfil de risco ou verificação de documentos.
* É **agnóstico ao ativo, ledger ou lógica de agrupamento** que as contas do Midaz usam.
* Dá acesso consistente aos metadados do titular sem carregar a camada de transação.

## Segurança e conformidade

***

A Lerian entrega o Midaz e seus componentes para implantação on-premise. **Você mantém o controle** da sua infraestrutura, das suas políticas de conformidade e do ciclo de vida dos dados de usuário.

O CRM é entregue com o Midaz e segue os mesmos padrões de segurança do restante da plataforma:

* **Dados em trânsito**: O Midaz os criptografa com protocolos padrão da indústria.
* **Dados em repouso**: O Midaz os protege com criptografia e controle de acesso granular.

<Danger>
  Você é responsável pelas chaves de criptografia. Use um serviço de gerenciamento de secrets para armazenar, rotacionar e controlar o acesso às chaves.
</Danger>

Você define e aplica suas próprias políticas para LGPD, GDPR e outras normas regionais de proteção de dados. O CRM fornece a estrutura.

Revise as [Recomendações de segurança](/pt/midaz/security-recommendations) antes de implantar qualquer componente no seu ambiente.

Aplique as melhores práticas de segurança a cada componente — **Access Manager**, **Fees Engine**, **Pix** e **CRM**. Proteja os limites de rede, gerencie os secrets, aplique patches e imponha um controle de acesso rigoroso.

## Estratégias de exclusão de dados

***

O CRM oferece controle total sobre como ele remove os dados. Ele oferece duas opções:

* **Soft delete** (padrão): O CRM marca o registro como excluído, mas o mantém no banco de dados. Use-o para manter uma trilha de auditoria ou recuperar dados mais tarde.
* **Hard delete**: Quando sua política permite a remoção, você pode solicitar a exclusão dos dados. A remoção física depende da sua configuração de retenção, conformidade e retenção legal (legal hold).

Suas políticas definem o comportamento. O CRM se adapta aos seus requisitos de conformidade.

## Controle de acesso

***

Para restringir quem pode acessar seus dados do CRM, habilite o nosso [Access Manager](/pt/platform/access-manager/access-manager).

### Habilitando o Access Manager

Primeiro, instale o **Access Manager**. Em seguida, abra o arquivo `.env` do ledger do Midaz e defina estas variáveis de ambiente:

<CodeGroup>
  ```text Text theme={null}
  ## AUTH
  ---

  PLUGIN_AUTH_HOST=http://plugin-auth:4000
  PLUGIN_AUTH_ENABLED=true
  ```
</CodeGroup>

Depois de habilitá-lo, o CRM aplica as permissões de acesso a partir da sua configuração de autenticação.

<Tip>
  O Access Manager está disponível no modelo Enterprise.
  Para avaliá-lo, [entre em contato com nossa equipe](https://lerian.studio/contact).
</Tip>

<Tip>
  Pronto para começar? Consulte [Primeiros passos com o CRM](/pt/midaz/crm/crm-getting-started) para um guia passo a passo.
</Tip>

## Próximos passos

***

<CardGroup cols={2}>
  <Card title="Conceitos principais" icon="book" href="/pt/midaz/crm/crm-core-concepts-overview">
    Entenda as entidades-chave que o CRM gerencia: Holders e Alias Accounts.
  </Card>

  <Card title="Explorar a API do CRM" icon="terminal" href="/pt/reference/midaz/crm/create-holder">
    Consulte endpoints para holders, alias accounts e partes relacionadas.
  </Card>

  <Card title="Usando o CRM" icon="rocket" href="/pt/midaz/crm/crm-using-overview">
    Aprenda a registrar holders e vinculá-los a contas do ledger.
  </Card>
</CardGroup>
