Skip to main content
Lerian home page
v3.x.x
English
Search...
⌘K
About us
Blog
Contact us
Contact us
Search...
Navigation
Understanding Midaz
Rest API
Welcome
Guides
API Reference
Platform
Partner's Hub
Updates & Versioning
Midaz
Midaz Core
Midaz Console
Plugins
Getting started
Overview
Getting help
FAQ
Understanding Midaz
Overview
Core features
Rest API
Data model
Architecture
Security
Observability
Installing & deploying
Overview
Security recommendations
Installing Midaz
Updating Midaz
Deployment strategies
Lerian MCP
Use cases
Overview
Midaz in banking
Midaz in a global portfolio
Midaz for academic records
Midaz for supply chains
Core entities
Overview
Organizations
Ledgers
Assets
Accounts
Portfolios
Segments
Balances
Transaction Routing
Transactions
Operations
Recommended workflow
Best practices
Overview
Common mistakes to avoid
Scalability strategies
Structuring bank operations with Midaz
Midaz production best practices
Midaz SDKs & libs
Overview
Midaz SDKs
Midaz libs
On this page
Key features
Understanding Midaz
Rest API
Copy page
Copy page
Midaz APIs are designed to provide consistent, secure, and scalable access to the platform’s services. Built on RESTful principles, they ensure smooth integration and adaptability to evolving requirements.
Key features
RESTful design
: Adheres to REST principles, ensuring predictability and compatibility.
JSON format
: All data exchanges use JSON for simplicity and interoperability.
Versioning
: Explicit versioning ensures backward compatibility during updates.
Midaz is structured into three domains:
Onboarding
,
Portfolio
, and
Transactions
, each with APIs and endpoints tailored to specific functionalities.
Looking for technical details on available endpoints? Check out the
API Reference
.
Core features
Previous
Data model
Next
⌘I