Skip to main content
The Settings panel is your central control for everything specific to your brokerage — branding, KYC policy, document requirements, notification templates, and security configuration. Access it by clicking Settings in the left sidebar of the kycert dashboard.

Sections of the Settings panel

Identity

The Identity section stores your brokerage’s public-facing profile. Keep this information accurate — it appears in customer-facing emails, the onboarding portal footer, and compliance reports.
FieldDescription
nameYour brokerage’s legal or trade name
cnpjYour CNPJ (used in compliance documents and reports)
logo_urlURL of your brokerage logo, displayed in the portal and PDFs
primary_colorPrimary brand color (hex) applied to portal buttons and headers
secondary_colorAccent color for secondary UI elements
contact_emailDefault reply-to address for outgoing customer emails
whatsapp_numberWhatsApp number shown in the portal footer for customer support
footer_instagramInstagram profile URL for the portal footer
footer_facebookFacebook page URL for the portal footer
footer_twitterX (Twitter) profile URL for the portal footer
footer_linkedinLinkedIn company page URL for the portal footer
footer_youtubeYouTube channel URL for the portal footer
footer_websiteYour brokerage website URL for the portal footer

Portal

The Portal section controls how the customer-facing onboarding wizard looks and behaves. Changes here affect all new customer sessions immediately.
SettingDescription
Welcome messageIntroductory text shown on the first screen of the onboarding portal
success_screenConfigures the result screen each customer sees after completing their submission. Supports four status states: approved (aprovado), under analysis (em_analise), rejected (recusado), and pending (pendencia). For each state you can set a title, message, call-to-action label, CTA URL, and a list of next steps. Choose from three display models: card, minimal, or bold.
custom_termsAdd one or more custom terms documents that customers must accept during onboarding. Each term has a key, display title, and a short description (short).
required_documents_pfList of document types required for Pessoa Física (individual) customers. Defaults: identidade_frente, comprovante_endereco, selfie.
required_documents_pjList of document types required for Pessoa Jurídica (corporate) customers. Defaults: contrato_social, comprovante_cnpj.
custom_documents_pfAdditional custom document slots for PF customers (beyond the preset list)
custom_documents_pjAdditional custom document slots for PJ customers (beyond the preset list)
hidden_preset_docs_pfPreset document types to hide from PF customers in the portal
hidden_preset_docs_pjPreset document types to hide from PJ customers in the portal
You can also configure per-type flow overrides under Portal → Flow Settings to enable or disable specific fields independently for PF and PJ onboarding:
Flow settingApplies toDescription
verify_emailPF / PJRequire customers to verify their email address via a one-time code
verify_phonePF / PJRequire customers to verify their phone number via SMS OTP
address_modePF / PJmanual — customer types their address; bureau — address is auto-filled from bureau data
field_birth_datePF onlyShow the date of birth field in the onboarding form
field_nationalityPF onlyShow the nationality field in the onboarding form
field_professionalPF / PJShow the profession/occupation field
field_incomePF / PJShow the income (PF) or annual revenue (PJ) field
income_modePF / PJspecific — customer enters an exact value; range — customer selects an income bracket

KYC Policy

KYC Policy is where you configure the compliance rules that govern how the bureau engine handles specific risk signals. PEP Policy — controls what happens when a customer is identified as a Politically Exposed Person:
PEP PolicyBehavior
manual_reviewPEP customers are placed in the analysis queue for a human compliance decision (default)
auto_approvePEP status is noted in the record, but the customer is automatically approved without human review
auto_rejectPEP customers are automatically rejected without entering the review queue
The auto_approve PEP policy does not comply with BCB Circular 3.978/2020, which requires enhanced due diligence for Politically Exposed Persons. Use with caution and consult your compliance officer before enabling this option.
Bureau quota settings — control what happens when your monthly bureau credit balance is running low or exhausted:
SettingDescription
bureau_fail_on_quota_exceededWhen true (default), new bureau runs are blocked once your monthly credit quota is exhausted. When false, runs continue and overage charges apply.
Bureau credits alert thresholdkycert sends an email alert to your contact_email when your remaining credits fall below this number. Set it high enough to give you time to top up before operations are interrupted.
Changes to KYC Policy apply to new bureau runs only. Existing run results are not retroactively affected — previously computed results remain unchanged.

Notifications

The Notifications section lets you customize the transactional email templates kycert sends to your customers. All emails are sent from the sender address configured in resend_from. Configure templates for the following events:
  • Status change — approved: sent when a customer’s KYC status changes to approved.
  • Status change — rejected: sent when a customer is rejected after analysis.
  • Status change — pending: sent when a customer is placed in pending status awaiting additional information.
  • Submission confirmation: sent immediately after a customer completes their onboarding form submission.
Each template supports your brokerage’s logo and brand colors from the Identity section.

Security

The Security section controls session behavior for dashboard users.
SettingDescription
Session inactivity timeoutNumber of minutes of inactivity before the system automatically logs out a dashboard user. Enforcing a short timeout is recommended for compliance environments where analysts may leave workstations unattended.

Open Graph (White-label SEO)

Control how your onboarding portal appears when shared on social media or messaging apps. Set og_title, og_description, and og_image_url to display your brokerage branding instead of kycert defaults when a customer shares the portal link.