Quick start guide

Set up Midaz for the first time, from environment installation and configuration to creating your first ledger structure.

This guide is intended for developers setting up Midaz for the first time. If you’re looking for a business-level overview of how Midaz works, see What is Midaz?. For deployment options, see SaaS and BYOC.

Follow these steps to set up Midaz.

Step 1 - Set up your environment

---

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

• This will install Midaz Ledger.

Authentication and authorization

Midaz does not include a built-in authentication or authorization system. You can integrate Midaz with your existing identity provider or security stack.

If you need a ready-to-use solution, you can enable Access Manager, an optional feature developed by Lerian. It handles authentication and authorization for Midaz and other Lerian products.

Access Manager 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 your workflows use.

Step 2.1 - Create an Organization

The first step is to create your Organization within Midaz.

• To create an Organization, use the Create an Organization endpoint.

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

• 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

Create at least one Ledger in each Organization. You can create multiple Ledgers if needed.

• To create a Ledger, use the Create a Ledger endpoint.

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

Each Ledger can have multiple Assets. Create each Asset individually.

• To create an Asset, use the Create an Asset endpoint.

When you create an Asset, Midaz automatically sets up an External Account if one doesn’t already exist. The External Account backs all transactions that flow in and out of the Ledger.

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

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 clusters accounts according to user-defined policies.

• To create a Segment, use the Create a Segment endpoint.

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

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 (optional)

Create a Portfolio to group your accounts of different Assets.

• To create a Portfolio, use the Create a Portfolio endpoint.

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

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. Each Account holds one Asset.

• To create an account, use the Create an Account endpoint.

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

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

---

See the API reference to learn more about Midaz, from metadata handling to idempotency.

Need help?

---

• Explore our Documentation hub for in-depth guides and resources.
• Contact our support team for personalized assistance.