The Midaz APIs deliver reliable, secure, and scalable access to the platform’s services, empowering seamless integration and adaptability to your evolving needs.
Designed with RESTful principles, they provide a robust foundation for building innovative solutions.
Key Highlights
- RESTful Architecture: Ensures predictable, consistent, and easy-to-use APIs.
- JSON Data Exchange: Simplifies integrations with universal format compatibility.
- Explicit Versioning: Guarantees backward compatibility during updates.
- Secure Authentication: Leverages OAuth 2.0 for robust and reliable access control.
Authentication and Security
Midaz APIs use OAuth 2.0 to safeguard access. Include the token in the request header as shown:
Authorization: Bearer <token>
Tokens ensure secure and authenticated communication, protecting sensitive data every step of the way.
Midaz APIs
Midaz is structured into three domains: Onboarding, Portfolio, and Transactions, each with APIs and endpoints tailored to specific functionalities. The tables below provide an overview of the available endpoints within each domain:
Onboarding Domain
| API | Endpoint |
|---|---|
| Organizations API | Create an Organization |
| List Organizations | |
| Retrieve an Organization | |
| Update an Organization | |
| Delete an Organization |
| API | Endpoint |
|---|---|
| Ledgers API | Create a Ledger |
| List Ledgers | |
| Retrieve a Ledger | |
| Update a Ledger | |
| Delete a Ledger |
Portfolio Domain
| API | Endpoint |
|---|---|
| Assets API | Create an Asset |
| List Assets | |
| Retrieve an Asset | |
| Update an Asset | |
| Delete an Asset |
| API | Endpoint |
|---|---|
| Segments API | Create a Segment |
| List Segments | |
| Retrieve a Segment | |
| Update a Segment | |
| Delete a Segment |
| API | Endpoint |
|---|---|
| Portfolios API | Create a Portfolio |
| List Portfolios | |
| Retrieve a Portfolio | |
| Update a Portfolio | |
| Delete a Portfolio |
Transactions Domain
| API | Endpoint |
|---|---|
| Operations API | List Operations by Account |
| Retrieve an Operation by Account |