What You’ll Learn in This Article:
- How to install and configure the BriteVerify integration
- How to configure email field and validation options
- How to use domain whitelisting
- How to test and troubleshoot
Installation
Step 1: Go to the profile menu (top-right) → select “Extensions”
Step 2: Scroll to the Admin section, find BriteVerify, click Install
Step 3: Go to the Integrations tab → + New Integration → select BriteVerify → note the Integration ID shown to the left of the integration name
Overview
The BriteVerify integration validates email addresses submitted through Digioh widgets (pop-ups, inlines, banners, etc.) before allowing form submission. This helps reduce:
- Invalid or mistyped email addresses
- Disposable email usage
- Role-based addresses (e.g. admin@, support@)
The integration runs during form submission and determines whether an email should be accepted or rejected based on BriteVerify results and configured settings.
How It Works
When a user submits a form:
- Digioh validates the email field.
- Optional overrides (such as domain whitelisting) are applied.
- A request is sent to BriteVerify.
- The response is evaluated:
- valid → accepted
- accept_all → optionally accepted
- unknown → optionally accepted
- Additional filters are applied:
- Disposable email check
- Role address check
- If valid → form submits. If invalid → error is shown.
Required Configuration
1. BriteVerify Integration ID Set the following Account Metadata: brite_verify_proxy_integration_id = YOUR_INTEGRATION_ID
Optional (site-specific override): brite_verify_proxy_integration_id:yourdomain.com = YOUR_INTEGRATION_ID
2. Email Field Configuration Set which field contains the email: email_field = email or email_field = custom_1
Optional Configuration
Allow Accept-All Emails brite_verify_allow_accept_all = true Allows emails where the domain accepts all messages.
Allow Unknown Emails brite_verify_allow_unknown = true Allows emails where BriteVerify cannot determine validity.
Disallow Disposable Emails brite_verify_disallow_disposable = true Blocks temporary or disposable email providers.
Disallow Role-Based Emails brite_verify_disallow_role_address = true Blocks emails like:
- admin@
- support@
- info@
Domain Whitelisting
The BriteVerify integration supports domain whitelisting, allowing specific email domains to bypass validation entirely. This is useful for trusted domains or providers that may return unknown results from BriteVerify (e.g. t-online.de, magenta.de).
How It Works
When configured:
- The email domain is extracted (e.g. gmail.com)
- If the domain is in the whitelist:
- BriteVerify is skipped
- The email is treated as valid
- The form submits immediately
- If not:
- Normal BriteVerify validation applies
Configuration
Metadata Key: brite_verify_domain_whitelist Value: Comma-separated list of domains: t-online.de,magenta.de
Scope
- Account-level supported
- Campaign-level override supported
- Campaign-level metadata takes priority over account metadata
Behavior Summary
| Scenario | Behavior |
|---|---|
| Domain is whitelisted | BriteVerify is skipped |
| Domain is not whitelisted | BriteVerify runs normally |
| Whitelist is empty/invalid | Ignored, normal behavior |
Important Notes
- Domains must NOT include @
- ✅ gmail.com
- ❌ @gmail.com
- Matching is exact
- t-online.de ≠ mail.t-online.de
- Whitelisting bypasses:
- BriteVerify API
- Disposable checks
- Role address checks
- Other settings still apply to non-whitelisted domains
Example Use Cases
- International ISPs returning unknown
- Trusted partner domains
- Reducing friction in signup forms
Troubleshooting
Emails are still being rejected Check:
- Is the domain correctly listed?
- No spaces or formatting issues?
- Is metadata set at correct level (Account vs Campaign)?
Whitelist not working Verify:
- Metadata key is correct
- Domains are comma-separated
- No @ symbol included
BriteVerify not triggering Check:
- Integration ID is set
- Email field is configured correctly
Best Practices
- Use whitelisting sparingly (only trusted domains)
- Prefer allowing unknown only when necessary
- Always test in QA mode before publishing
Testing (QA Mode)
Use ?boxqamode to test changes safely before publishing.