Skip to main content
The Settings page is where an administrator configures how BC Correios connects to the Banco Central do Brasil (BCB) and how it processes mail. It groups configuration into collapsible sections: BCB credentials, polling, retention, webhook, and AI.

​
Accessing Settings

Open Reporter > BC Correios > Settings from the left-side menu.
Viewing Settings requires the settings:get permission. Saving changes and testing connections require write permissions (settings:patch / settings:post). With read-only access, you see the current configuration with a read-only banner.

​
BCB credentials

The Sisbacen credentials used to access the BC Correio mailbox.
  • Username — your Sisbacen username.
  • Password — your Sisbacen password.
A badge shows whether the credentials are Configured or Not configured. For security, stored secrets are never displayed back — leave a field blank to keep the existing value.
Without valid BCB credentials, BC Correios cannot synchronize mail. If the Dashboard sync status shows credentials as invalid, update them here first.

​
Polling

Controls how often BC Correios fetches new mail from the BCB.
  • Polling interval — choose 5, 15, 30, or 60 minutes.

​
Retention

The minimum period mail is kept.
  • Retention (days) — minimum 5 years (1,825 days), maximum 100 years. The equivalent in years is shown next to the field.
Retention enforces the regulatory minimum. This is why BC Correios has no user-facing delete — see mail folders.

​
Webhook

Optional outbound notification when new mail is received.
  • Webhook URL — the endpoint to notify.
  • HMAC secret — used to sign webhook payloads so your receiver can verify authenticity.
A badge shows whether the webhook is Enabled or Disabled based on whether a URL is set.

​
AI provider

Optional automatic analysis of regulatory mail, on a bring-your-own-key basis. When configured, summaries appear in the mail detail AI insight panel.
FieldDescription
ProviderNone, OpenAI, Anthropic, or Google Gemini.
API keyYour provider API key.
ModelThe model to use (for example gpt-4o-mini).
EndpointOptional custom endpoint, for self-hosted or proxied providers.
System promptOptional instructions that shape the AI analysis.
Use Test connection to verify the AI configuration before saving; on success the response latency is reported.

​
Saving changes

When you edit any field, a save bar appears with Discard and Save actions. BC Correios sends only the fields you changed, and shows a confirmation when the save succeeds.
Configuration changes are recorded in the Audit trail as Settings updated and BCB connection tested events.