Skip to main content
CRM no forma parte del dominio transaccional del ledger. Agrega atributos de negocio a las cuentas del ledger. No cambia la lógica, la consistencia ni el rendimiento del ledger. CRM es donde vive el metadato de usuario. No contiene saldos, transferencias ni comisiones. Registra quién está detrás de una cuenta y qué necesitas para operar tu negocio.

​
API actual

CRM se sirve desde el Ledger solo en /v2, bajo /v2/organizations/{organization_id}/.... /v1 no expone CRM. Usa el espacio de nombres de autorización midaz con los recursos holders e instruments. Midaz es source-available bajo ELv2.
Prueba CRM localmentePuedes ejecutar CRM con el stack de Midaz de forma local, sin Kubernetes, usando nuestro repositorio plugins-docker-compose.

​
¿Por qué usar CRM?

Las cuentas del ledger de Midaz son genéricas por diseño. Priorizan la transacción y son agnósticas de dominio. CRM agrega significado a esas cuentas y vincula cada una con un perfil de usuario y un contexto de negocio. No es obligatorio usar CRM. Puedes adoptarlo más adelante, solo cuando tu caso de uso necesite metadatos de cliente o de negocio más allá del ledger.

​
Ejemplos de casos de uso

  • Banca (personas y empresas): CRM almacena identificadores como CPF o CNPJ, una dirección, datos de contacto o números de cuenta. Midaz ejecuta la misma lógica de transacción para ambos tipos de cliente.
  • Cadenas de suministro (proveedor, fábrica, minorista): CRM registra metadatos como identificadores de proveedor, ubicaciones de almacén o detalles de contrato. Estos datos no pertenecen a la transacción, pero orientan decisiones de negocio.
CRM se distribuye dentro del ledger de Midaz, así que no hay un servicio independiente que desplegar. Úsalo solo si tu producto o contexto regulatorio necesita metadatos de cliente o de negocio.

​
Entidades

CRM tiene dos entidades principales:
  • Holder – La entidad principal en CRM. Representa la persona detrás de una cuenta del ledger de Midaz. Almacena atributos de identidad y rasgos individuales.
  • Instrument – El contexto de negocio de una cuenta del Ledger en Midaz Ledger. Contiene datos financieros como la información de cuenta bancaria.
La Figura 1 muestra cómo se conectan las entidades de CRM con Midaz.
Cómo se conectan las entidades de CRM, el Holder y el Instrument, con las cuentas en el ledger de Midaz

Figura 1. Una ilustración de cómo se conectan las entidades de CRM con Midaz

​
Principios de diseño

CRM se centra en:
  • Separación de responsabilidades: mantiene los datos del perfil de usuario fuera de la lógica de transacción.
  • Rendimiento del sistema: no agrega orquestación a nivel de usuario dentro de los servicios core de Midaz.
  • Despliegue más simple: CRM se distribuye dentro del binario del ledger, sin un servicio independiente que ejecutar.
  • Límites de dominio claros: evoluciona junto con Midaz sin acoplarse a los internos del ledger.
CRM no valida reglas a nivel de ledger ni procesos de cumplimiento como KYC. Es una capa de datos neutral y persistente.

​
Comportamiento de la API

CRM se ejecuta dentro del binario del ledger de Midaz. Expone una API de registro para datos no transaccionales vinculados a cuentas de Midaz.
  • No aplica validaciones como estado del usuario, perfil de riesgo o verificación de documentos.
  • Es agnóstico del activo, el ledger o la lógica de agrupación usados en las cuentas de Midaz.
  • Da acceso consistente a los metadatos del holder sin cargar la capa de transacción.

​
Seguridad y cumplimiento

Lerian distribuye Midaz y sus componentes para despliegue on-premise. Tú mantienes el control de tu infraestructura, tus políticas de cumplimiento y el ciclo de vida de los datos de usuario. CRM se distribuye con Midaz y sigue los mismos estándares de seguridad que el resto de la plataforma:
  • Datos en tránsito: Midaz los cifra con protocolos estándar de la industria.
  • Datos en reposo: Midaz los protege con cifrado y control de acceso granular.
Tú eres responsable de la gestión de las claves de cifrado. Usa un servicio de gestión de secretos para almacenar, rotar y controlar el acceso a las claves.
Tú defines y aplicas tus propias políticas para LGPD, GDPR y otras normas regionales de protección de datos. CRM aporta la estructura. Revisa las Recomendaciones de seguridad antes de desplegar cualquier componente en tu entorno. Aplica buenas prácticas de seguridad a cada componente: Access Manager, Fees Engine, Pix y CRM. Protege los límites de red, gestiona secretos, aplica parches y refuerza el control de acceso.

​
Estrategias de eliminación de datos

CRM te da control total sobre cómo elimina datos. Ofrece dos opciones:
  • Eliminación reversible (predeterminada): CRM marca el registro como eliminado, pero lo conserva en la base de datos. Úsala para mantener un registro de auditoría o para recuperar datos más adelante.
  • Eliminación definitiva: donde tu política lo permita, puedes solicitar la eliminación de los datos. La eliminación física depende de tu configuración de retención, cumplimiento y retención legal.
Tus políticas definen el comportamiento.

​
Control de acceso

Para restringir quién puede acceder a tus datos de CRM, habilita nuestro Access Manager.

​
Habilitar Access Manager

Primero, instala Access Manager. Luego abre el archivo .env del ledger de Midaz y configura estas variables de entorno:
Después de habilitarlo, CRM aplica los permisos de acceso desde tu configuración de autenticación.
Access Manager está disponible bajo el modelo Enterprise. Para evaluarlo, contacta a nuestro equipo.
Consulta Primeros pasos con CRM para una guía paso a paso.

​
Próximos pasos

Conceptos básicos

Comprende las entidades clave que gestiona CRM: Holders e Instruments.

Explora la API de CRM

Explora los endpoints de holders, instruments y partes relacionadas.

Usar CRM

Aprende a registrar holders y vincularlos a cuentas del ledger.