> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Managing Institutions

> Register the institutions your tenant reports for in the Reporter module of the Lerian Console: CNPJ, data scope per Data Source, and proposals read from Midaz.

An **institution** is one regulatory declarant of your tenant. Each institution files under its own CNPJ and reads only the rows that its scope names. Manage institutions on the **Institutions** page of Reporter in the [Lerian Console](/en/platform/console/about-lerian-console).

Reports, regulatory deadlines, and regulatory filings use the institutions that you register here. See [Where institutions apply](#where-institutions-apply).

## Accessing the Institutions page

***

To open the **Institutions** page, click **Institutions** in the left-side menu of the **Reporter** page.

The page lists the institutions in a table with these columns: **Name**, **CNPJ**, **Data Sources**, **Last Modified**, and **Actions**. The **Data Sources** column names each Data Source in the scope of the institution. It shows **None** when the scope is empty.

The menu (<Icon icon="ellipsis-vertical" />) of each row has **Edit** and **Delete**.

Each action on the Institutions screen needs the matching `institutions` permission: `get` to see and propose institutions, `post` to create and confirm, `put` to edit, and `delete` to delete.

## Add an institution

***

<Steps>
  <Step title="Open the form">
    On the **Institutions** page, click **New Institution**.
  </Step>

  <Step title="Identify the institution">
    Enter the **Business name** and the **CNPJ**. The CNPJ can be numeric or alphanumeric, with or without punctuation.
  </Step>

  <Step title="Define the scope">
    Click **Add data source** and select a Data Source. Then tell Reporter which of its rows belong to the institution. See [Scope rules](#scope-rules).
  </Step>

  <Step title="Save">
    Click **Save**. If Reporter refuses the institution, the form shows its reason and keeps what you typed.
  </Step>
</Steps>

### Scope rules

The scope names the rows of each Data Source that belong to the institution. An institution with no Data Source in its scope reads nothing.

For each Data Source, choose one of these:

* **The whole data source belongs to this institution**: the institution reads every table of the Data Source.
* **Tables**: click **Add table** and enter the table name. For each table, choose one of these:
  * **Shared: every institution reads this table whole**: use it for reference data that every institution needs.
  * **Conditions**: click **Add condition**, type the **Field**, select an **Operator**, and type the **Values**, comma separated. A table with conditions needs at least one condition with the **Equal** or the **In** operator. These two operators claim the rows of the institution.

### Field guide

| Field | What to enter | Example |
| - | - | - |
| **Business name** | Required. The name of the declarant, up to 255 characters. | `Banco Exemplo S.A.` |
| **CNPJ** | Required. The form checks the check digits. | `12.345.678/0001-95` |
| **Data source** | A Data Source registered on the **Data Sources** page. A Data Source appears once in a scope. | `midaz-postgres` |
| **Table** | A table of the Data Source. A table appears once in a Data Source. | `account` |
| **Field** | The column that identifies the rows of the institution. | `organization_id` |
| **Operator** | **Equal**, **In**, **Not In**, **Greater Than**, **Greater or Equal**, **Less Than**, **Less or Equal**, or **Between**. | **Equal** |
| **Values** | One or more values, comma separated. | `00000000-0000-0000-0000-000000000000` |

## Propose institutions from Midaz

***

Reporter can read the organization table of Midaz and propose one institution for each organization that is not registered yet.

<Steps>
  <Step title="Open the proposals panel">
    On the **Institutions** page, click **Propose from Midaz**.
  </Step>

  <Step title="Select the Data Sources">
    Under **Data sources to read**, select the PostgreSQL Data Sources that read Midaz. The panel lists the PostgreSQL Data Sources that you registered. It does not list Data Sources provided by the platform.
  </Step>

  <Step title="Find the proposals">
    Click **Find proposals**. Each proposal shows the name, the CNPJ, and the proposed scope in each Data Source.
  </Step>

  <Step title="Confirm a proposal">
    Click **Confirm** on a proposal. The **New Institution** form opens with the proposal filled in. Review it, then click **Save**. When you close the form, the proposals panel opens again.
  </Step>
</Steps>

<Warning>
  Midaz does not check the CNPJ check digits. A proposal with an incorrect CNPJ shows a warning. Correct the CNPJ in the form before you save.
</Warning>

## Edit an institution

***

Click the name of the institution, or select **Edit** in the row menu. Change the fields, then click **Save**.

## Delete an institution

***

Select **Delete** in the row menu and confirm. After the deletion, you can register the same CNPJ again at once.

## Where institutions apply

***

| Where | What the Console asks |
| - | - |
| **Reports** > **New Report** | With one institution, the wizard uses it. With several, choose one institution or **All institutions**. With none, the wizard does not ask. |
| **Overview** > **Add Reminder**, type **Regulatory** | The same rule as a report. |
| **Regulatory Filing** > **Activate document** | With one institution, the dialog uses it. With several, choose the institution that files the document. A filing never offers **All institutions**. Register at least one institution before you activate a document. |

When the tenant has several institutions, **Regulatory Filing** also shows these items:

* Each subscription shows the institution it files for, or **No institution set**. Set the institution before you generate a draft.
* **Activate for another institution** appears on an activated document when an institution does not file it yet.
* **Set institution** in the menu of a subscription changes the institution for the next filings. Reports already generated keep their institution.

Subscribing to a document and generating, correcting or adopting its filings needs `regulatory:post`. Mapping its fields and setting its institution need `regulatory:put`. Deactivating a subscription needs `regulatory:delete`. Approving a draft needs `regulatory-approval:post`.

## Next steps

***

* Use [Generate a Report](/en/products/reporter/console/generating-a-report) to generate a Report for an institution.
* Use [Managing Data Sources](/en/products/reporter/console/managing-data-sources) to register the Data Sources that a scope names.

<Card title="API equivalent" type="tip" horizontal>
  [Create institution endpoint](/en/reference/products/reporter/create-institution) and [Propose institutions endpoint](/en/reference/products/reporter/propose-institutions)
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.