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 > Configurações from the left-side menu. The screen title is Settings.
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.
  • BCB username: your Sisbacen username.
  • BCB 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.
  • Sync interval: choose 5, 15, 30, or 60 minutes.

​
Retention

The minimum period to keep mail.
  • Retention days: minimum 5 years (1,825 days), maximum 100 years. The equivalent in years appears 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 arrives.
  • 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 exists.

​
AI provider

Optional automatic analysis of regulatory mail, on a bring-your-own-key basis. When configured, summaries appear in the mail detail AI analysis panel. Use Test connection to verify the AI configuration before saving. On success, the test reports the response latency.

​
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 Updated settings and Tested BCB connection events.