API Reference

Quick start guide

Starting with Midaz is straightforward. Follow these steps to build your foundation and explore the possibilities.


Step 1 - Set up your environment

To set up your Midaz environment, follow the steps in the Installing Midaz monorepo page.

  • This will install Midaz Ledger and Midaz Console simultaneously.

Authentication and authorization

Midaz does not include a built-in authentication or authorization system. This gives you the flexibility to integrate with your existing identity provider or security stack.

If you need a ready-to-use solution, you can add Access Manager, a separate paid plugin developed by Lerian. It handles both authentication and authorization, making it easier to control who can access what across your Midaz ecosystem.

✅

Tip

Access Manager is fully compatible with Midaz and supports common identity standards like OAuth2 and OIDC. For more details, refer to the Access Manager guide.



Step 2 - Create your Midaz structure

Start by creating the data structure that powers your workflows.


Step 2.1 - Create an Organization

The first step is to create your Organization within Midaz.

👍

Organizational Structure

If your organization has multiple branches, you can create various Organizations and designate a "Parent Organization."

For example, if Company XYZ has branches in New York and Brazil, you can create an Organization for Company XYZ and set it as the parent of XYZ New York and XYZ Brazil.


For a complete list of endpoints to manage your Organization, expand the section below:

Managing Organizations

Step 2.2 - Create a Ledger

Each organization must have at least on Ledger. However, you can have multiple Ledgers within each Organization if needed.

For a complete list of endpoints to manage your Ledger, expand the section below:

Managing Ledgers
  • Retrieve all Ledgers using the List Ledgers endpoint.
  • Retrieve a specific Ledger with the Retrieve a Ledger endpoint.
  • Update Ledger details using the Update a Ledger endpoint.
  • Delete a Ledger in Homologation using the Delete a Ledger endpoint.
    • For Ledgers in Production, deletion requires contacting Lerian support for security purposes.

Step 2.3 - Create the Assets

Your Organization can have multiple Assets. However, each Asset must be created individually, allowing for specific configurations like decimal places.

👍

External Account

When you create an Asset, Midaz automatically sets up an External Account if one doesn’t already exist. This ensures seamless backing for all transactions flowing in and out of the Ledger.

For a complete list of endpoints to manage your Assets, expand the section below:

Managing Assets

Step 2.4 - Create a Segment (optional)

If you want, you can use the Segment ID as a custom grouping label that enables clustering accounts according to user-defined policies, supporting efficient account segmentation and management.

For a complete list of endpoints to manage your Segment, expand the section below:

Managing Segment

Step 2.5 - Create a Portfolio

Create a Portfolio to group your accounts of different Assets.

For a complete list of endpoints to manage your Portfolios, expand the section below:

Managing Portfolios

Step 2.6 - Create the Accounts

You can now add the accounts related to the Assets you want to use with the Ledger. You will have to create one account for each Asset.

For a complete list of endpoints to manage your Accounts, expand the section below:

Managing Accounts

Step 3 - Explore our APIs

Dive into the API reference to learn more about how Midaz can elevate your operations. From metadata handling to idempotency, every detail is crafted for simplicity and efficiency.


Need help?

You're not alone. We’re here to support you every step of the way.