What BC Correios covers
Once enabled, BC Correios adds a section to the Reporter sidebar with the following areas:
- Dashboard — KPIs for received and pending mail, a chart of mail categories, sync status, and recent activity.
- Inbox — searchable, filterable list of incoming mail, with a detail view that shows attachments and an optional AI insight panel.
- Compose — send a new communication to the BCB (recipient, subject, content, and keywords) via the BCB
TransmitirCorreiooperation. - Sent — communications transmitted to the BCB.
- Cancelled — mail in a cancelled state. This folder is read-only because the BCB reports the state upstream.
- Archived — mail you have archived locally for organization.
- Audit — an immutable audit trail of events, with CSV export for compliance evidence.
- Settings — BCB credentials, polling interval, AI provider, webhook, and retention configuration.
Archiving and restoring are local-only organizational actions — they update the BC Correios database and never change anything on the BCB side. Regulatory mail is retained to meet the minimum retention requirement; there is no user-facing delete.
Mail types
BC Correios categorizes incoming mail to help you triage regulatory communications:
| Type | Meaning |
|---|---|
| Circular | A BCB circular. |
| Resolution | A BCB resolution. |
| Communication | A general BCB communication. |
| Other | Any communication that does not match the categories above. |
How availability is controlled
BC Correios has two levels of activation:
1. Infrastructure flag (set by your DevOps/deploy team)
The flagNEXT_PUBLIC_BC_CORREIOS_ENABLED controls whether BC Correios is visible at all in the Console. It is disabled by default and must be set at the Console container level — via Helm values or environment variables — before anything appears in the UI.
This is a deploy-time setting, not something changed inside the Console itself. See Lerian Console via Helm for where to set it.
Because the flag is read at runtime, toggling it requires restarting the Console container — no rebuild needed. When the flag is off, all BC Correios pages are hidden.
2. Organization toggle (set by a Console admin)
Once the infrastructure flag istrue, a BC Correios card appears in Reporter → Settings → Plugins. An administrator can use the toggle on that card to enable or disable BC Correios for the organization without touching the deployment.
Where BC Correios appears
When both levels are active, BC Correios shows up as a collapsible section under PLUGINS in the Reporter sidebar, with the following items: Dashboard, Inbox, Sent, Archived, Cancelled, Audit, and Settings.If you expect BC Correios but do not see it in the Reporter sidebar, check in order: (1) confirm the infrastructure flag is
true for your environment; (2) confirm the plugin is toggled on in Reporter → Settings → Plugins. If both are set and it still does not appear, contact the Lerian team.Console vs API
Use the Console when an operator needs to read, send, search, and audit BCB mail through the visual interface. Use the BCB integration’s API when a system needs to automate reception or transmission programmatically. The same concepts apply in both places — the Console abstracts the BCB’s SOAP/XML mailbox behind a clean operator workflow.

