Skip to main content
This guide organizes every field used across the Lerian ecosystem into a single, reliable, and easy-to-navigate reference. It supports partners and development teams who need clarity and consistency across Midaz, Flowker, Identity, CRM, Fee, PIX, Auth, Reporter, and related plugins. This dictionary helps you validate payloads, improve interoperability, streamline QA, and accelerate integration development.

​
Why this dictionary matters

APIs evolve fast. New features, plugins, and versions bring new fields and behavior. This dictionary centralizes all definitions, making it easier to understand how our products communicate with each other. Use it to:
  • Build integrations with confidence
  • Reduce ambiguity across workflows
  • Validate payload structures
  • Support QA, observability, and debugging
  • Accelerate onboarding for new developers and partners

​
How to use this page

Each section groups fields by semantic categories. Every field includes:
  • Field name
  • Description
  • Where it is used across Lerian products
If you’re working with a specific product, scroll down to find dedicated subsections for Flowker, PIX, Identity, Fee Engine, and Reporter.
For strict schema validation, always check the official OpenAPI specifications. Those files reflect the exact structure required by each endpoint.

​
Before you explore

This dictionary follows consistent conventions across all products.
  • Dates use ISO 8601 or RFC3339 formats
  • UUIDs follow v4 formatting
  • PIX fields follow BACEN standards
  • Workflow fields follow Flowker’s runtime and authoring semantics
  • Fee Engine fields reflect the latest v2 model
  • Metadata is always a flexible key-value
If your integration uses sensitive operations like PIX, Identity, or Fee Engine, verify behavior and accepted formats directly in the product APIs. Some fields behave differently depending on the execution context.

​
Structure of the dictionary

The dictionary is divided into the following categories:

Core fields

Essential fields shared across all Lerian APIs, including identifiers, timestamps, pagination, and audit metadata.

People & Organizations

Fields that describe individuals, companies, users, groups, and organizational structures.

Financial data

Fields related to banking details, PIX operations, financial transactions, QR Codes, and operational limits.

Authentication & Security

Fields used for authentication, authorization, OAuth2 flows, webhook validation, and system health monitoring.

Workflows & Reporting

Fields related to workflow orchestration (Flowker), reporting (Reporter), fee calculations, and error handling.