Lerian APIs offer reliable, scalable, and secure access to everything the platform provides, from onboarding workflows and ledger management to plugins for authentication, fees, CRM, and reporting.
This section is your guide to every API Lerian offers. Whether you're integrating Midaz directly or building custom plugins, you'll find what you need here.
ImportantYou’re viewing the documentation for the latest version of Midaz and its plugins. If you’re working with an earlier release, check out the legacy docs to avoid version mismatches.
Key highlights
- RESTful and predictable: All endpoints follow standard HTTP methods and status codes.
- Consistent formats: Requests and responses use JSON, with clear typing and structures.
- Explicit versioning: APIs are versioned to prevent breaking changes.
- Plugin-first architecture: Many features are available as modular plugins, each with its own set of APIs.
NoteBuilding a plugin or integration for Lerian? The Partners Hub has everything you need, development standards, documentation rules, and tools to help your solution work smoothly across the Lerian ecosystem.
Recommended for partners, clients, and internal teams working on custom plugins
What you'll find here
- Introduction: Information you need to get started, including the quick start guide, sandbox instructions, and how Lerian’s license model works.
- Integration Essentials: Key concepts like retries, pagination, metadata structure, and other tools to build stable, reliable integrations.
- Stability & Quality: Lerian’s approach to error handling, testing, quality assurance, troubleshooting, and support.
- Midaz APIs: Core platform APIs for managing ledgers, transactions, assets, accounts, portfolios, and more.
- Plugin APIs: Modular APIs for authentication (Access Manager), CRM, Fees Engine, and Smart Templates.
- Error lists: Every core API and plugin has a dedicated reference page for error codes and handling.