Skip to main content
O CRM não faz parte do domínio transacional do ledger. Ele adiciona atributos de negócio às contas do ledger. Não altera a lógica, a consistência nem o desempenho do ledger. O CRM é onde vivem os metadados de usuário. Ele não guarda saldos, transferências ou tarifas. Ele registra quem está por trás de uma conta e o que você precisa para rodar seu negócio.

​
API atual

O CRM é servido pelo Ledger apenas em /v2, sob /v2/organizations/{organization_id}/.... O /v1 não expõe o CRM. Use o namespace de autorização midaz com os recursos holders e instruments. O Midaz é source-available sob a ELv2.
Teste o CRM localmenteVocê pode rodar o CRM com o stack do Midaz localmente, sem Kubernetes, usando nosso repositório plugins-docker-compose.

​
Por que usar o CRM?

As contas do ledger do Midaz são genéricas por design. Elas são orientadas à transação e agnósticas de 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. Pode adotá-lo depois, apenas quando seu caso de uso precisar de metadados de cliente ou de negócio além do ledger.

​
Exemplos de casos de uso

  • Bancário (pessoas físicas e jurídicas): o CRM guarda identificadores como CPF ou CNPJ, um endereço, dados de contato ou números de conta. O Midaz roda a mesma lógica de transação para os dois tipos de cliente.
  • Cadeias de suprimento (fornecedor, fábrica, varejista): o CRM rastreia metadados como IDs de fornecedor, localizações de armazém ou detalhes de contrato. Esses dados não pertencem à transação, mas orientam decisões de negócio.
O CRM vem embutido no ledger do Midaz, então não há um serviço separado para fazer deploy. Use-o apenas se o seu produto ou contexto regulatório precisar de metadados de cliente ou de negócio.

​
Entidades

O CRM tem duas entidades principais:
  • Titular – a entidade principal do CRM. Representa a persona de uma conta do ledger do Midaz. Guarda atributos de identidade e características individuais.
  • Instrumento – o contexto de negócio de uma conta do ledger no Ledger do Midaz. Guarda detalhes financeiros como informações de conta bancária.
A Figura 1 mostra como as entidades do CRM se conectam ao Midaz.
Como as entidades do CRM, Titular e Instrumento, se conectam a contas no ledger do Midaz

Figura 1. Uma ilustração de como as entidades do CRM se conectam ao Midaz

​
Princípios de design

O CRM foca 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 em nível de usuário dentro dos serviços do núcleo do Midaz.
  • Deploy mais simples: o CRM vem embutido no binário do ledger, sem serviço separado para rodar.
  • Fronteiras de domínio claras: evolui com o Midaz sem se acoplar aos internos do ledger.
O CRM não valida regras em nível de ledger nem processos de compliance como o KYC. É uma camada de dados neutra e persistente.

​
Comportamento da API

O CRM roda 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.
  • Ele é agnóstico ao ativo, ao ledger ou à lógica de agrupamento usados nas contas do Midaz.
  • Ele dá acesso consistente aos metadados de titular sem carregar a camada de transação.

​
Segurança e compliance

A Lerian entrega o Midaz e seus componentes para deploy on-premise. Você mantém o controle da sua infraestrutura, das suas políticas de compliance e do ciclo de vida dos dados de usuário. O CRM vem 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.
Você é responsável pelo gerenciamento das chaves de criptografia. Use um serviço de gerenciamento de segredos para guardar, rotacionar e controlar o acesso às chaves.
Você define e aplica suas próprias políticas para LGPD, GDPR e outras regras regionais de proteção de dados. O CRM fornece a estrutura. Revise as recomendações de segurança antes de fazer deploy de qualquer componente no seu ambiente. Aplique boas práticas de segurança a todos os componentes: Access Manager, Fees Engine, Pix e CRM. Proteja as fronteiras de rede, gerencie segredos, aplique patches e reforce o controle de acesso.

​
Estratégias de exclusão de dados

O CRM dá a você controle total sobre como ele remove dados. Ele oferece duas opções:
  • Exclusão reversível (padrão): o CRM marca o registro como excluído, mas o mantém no banco de dados. Use-a para manter uma trilha de auditoria ou recuperar dados depois.
  • Exclusão definitiva: onde 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, compliance e retenção legal.
Suas políticas definem o comportamento.

​
Controle de acesso

Para restringir quem pode acessar seus dados de CRM, habilite nosso 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:
Depois de habilitá-lo, o CRM aplica as permissões de acesso da sua configuração de autenticação.
O Access Manager está disponível no modelo Enterprise. Para avaliá-lo, fale com nosso time.
Veja Primeiros passos com o CRM para um guia passo a passo.

​
Próximos passos

Conceitos principais

Entenda as entidades principais gerenciadas pelo CRM: Titulares e Instrumentos.

Explore a API do CRM

Veja os endpoints para titulares, instrumentos e partes relacionadas.

Usando o CRM

Aprenda a cadastrar titulares e vinculá-los a contas do ledger.