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.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.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.
Managing Organizations
Managing Organizations
- Retrieve all Organizations using the List Organizations endpoint.
- Retrieve a specific Organization with the Retrieve an Organization
- Update Organization details using the Update an Organization endpoint.
- Delete an Organization in Homologation using the Delete an Organization endpoint.
- For Organizations in Production, deletion requires contacting Lerian support for security purposes.
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
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.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.
Managing Assets
Managing Assets
- Retrieve all Assets using the List Assets endpoint.
- Retrieve a specific Asset with the Retrieve an Asset endpoint.
- Update Asset details using the Update an Asset endpoint.
- Delete an Asset with the Delete an Asset endpoint.
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
Managing Segment
- Retrieve all Segments using the List Segments endpoint.
- Retrieve a specific Segment with the Retrieve a Segment endpoint.
- Update Segment details using the Update a Segment endpoint.
- Delete a Segment using the Delete a Segment endpoint.
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
Managing Portfolios
- Retrieve all Portfolios using the List Portfolios endpoint.
- Retrieve a specific Portfolio with the Retrieve a Portfolio endpoint.
- Update Portfolio details using the Update a Portfolio endpoint.
- Delete a Portfolio with the Delete a Portfolio endpoint.
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
Managing Accounts
- Retrieve all Accounts using the List Accounts endpoint.
- Retrieve a specific Account with the Retrieve an Account endpoint.
- Update Account details using the Update an Account endpoint.
- Delete an Account with the Delete an Account endpoint.
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.- Explore our Documentation hub for in-depth guides and resources.
- Join the Discord community.
- Contact our support team for personalized assistance.