Overview & Getting Started

The Mine Consent Management Platform (CMP) is a full-featured cookie consent solution for the web. It displays a consent banner to your visitors, blocks cookies and tracking scripts until consent is given, stores each user's decision, and reports analytics events so you can measure banner performance and consent rates.

This guide explains what the Mine CMP does, the key concepts you need to understand, and how to install a cookie consent banner on your website for the first time.

What the CMP does

When a visitor loads a page on your website, the Mine CMP:

1. Decides whether the visitor needs a consent banner, based on the rules you configured
2. Blocks cookies, scripts, and tracking elements that haven't been consented to
3. Displays the appropriate banner if needed
4. Records the user's decision and unblocks the categories they've consented to
5. Stores the decision so the banner doesn't appear again on repeat visits
6. Reports analytics events so you can track banner performance in the MineOS portal

Privacy regulations supported

The Mine CMP supports every major privacy regulation worldwide, so you can serve the right consent experience to every visitor regardless of where they're located. Supported regulations include:

• GDPR (European Union) and UK GDPR / PECR (United Kingdom)
• CCPA / CPRA (California) and other US state laws including Colorado, Connecticut, and Virginia
• PIPEDA (Canada)
• Privacy Act (Australia and New Zealand)
• PDPA (Singapore)
• POPIA (South Africa)
• KVKK (Turkey)
• LGPD (Brazil) and other LATAM, APAC, Middle East, and Africa frameworks
• And more...

You don't have to know the legal details of every framework to set up a compliant banner - the banner gallery (covered below) provides pre-configured templates for each major regulation.

Key concepts

Websites and configuration

A website is the unit of configuration in the MineOS portal. You create a website, configure your banners and rules inside it, and publish it. Publishing generates a configuration file hosted on the Mine CDN, which is what your site actually loads in the browser.

Each website has a unique ID that identifies its configuration.

Website scanning and cookie classification

When you add a website to the MineOS portal, the domains you list are scanned monthly to detect every cookie, script, and tracking element in use. Each detected cookie is automatically classified into a category (Necessary, Preferences, Analytics, Marketing, or Unclassified), so the CMP knows what to block and how to describe each item to your visitors in the preferences panel.

This means you don't need to maintain a cookie inventory by hand - the scan keeps your configuration current as third-party scripts come and go on your site.

Banner gallery and templates

The MineOS portal includes a banner gallery of pre-configured banner templates tailored to specific privacy regulations. Instead of building a banner from scratch, you can pick a template that already matches the legal requirements for your audience and customize it from there. Available templates include:

• GDPR Opt-in — for EU, UK, Turkey, and South Africa, where explicit prior consent is required
• Opt-out — for California (CPRA/CCPA) and US states like Colorado, Connecticut, and Virginia, where users have the right to opt out of sale or sharing
• Soft opt-in — for Canada (PIPEDA), Australia, New Zealand, and Singapore, where implied consent with an easy opt-out is acceptable
• Notice only — minimal informational notice for regions with lighter consent requirements (APAC, LATAM, Middle East, and most of Africa)

You can mix and match templates within a single website by combining them with rules, which serve different banners based on the visitor's location or URL patterns.

Rules and banner selection

A website can contain one or more rules. Each rule decides which banner to show based on the visitor's geo location and the current URL. Rules are evaluated in priority order, and the first rule whose conditions all match determines the banner. If no rule matches, no banner is shown.

This is how you serve a GDPR banner to EU visitors, a CCPA banner to California visitors, and a simple cookie notice everywhere else from the same configuration.

Rules also support A/B testing, with each visitor's variant assignment persisted across sessions.

Cookie categories

Cookies are grouped into five categories:

• Necessary — always enabled, cannot be disabled
• Preferences — optional
• Analytics — optional
• Marketing — optional
• Unclassified — always enabled, cannot be disabled to avoid the risk of breaking the website

Categories with no cookies configured are hidden from the banner automatically.

Consent modes

Each banner has a consent mode that determines what happens by default:

• OptIn — all categories blocked until the user explicitly consents (GDPR default)
• OptOut — all categories allowed until the user explicitly opts out (CCPA default)
• SoftOptIn — categories allowed after the user dismisses the banner without making a choice

Per-category default toggle states can be configured on top of the consent mode — for example, defaulting Analytics to on and Marketing to off in an OptIn banner.

Banner layers

Every banner has two layers:

• First layer — the initial consent prompt with Accept / Deny / Customize buttons
• Second layer — a detailed preferences panel for granular category selection

Users move from the first to the second layer by clicking Customize.

Automatic blocking

The CMP installs interceptors that block cookies, scripts, and tracking elements before they can run. Blocking is driven by the cookie data from your monthly website scan, combined with any manual overrides you've added directly in your site's markup.

Script load order matters here: the CMP must run before any tracking script on the page, which is why the install steps below require the CMP scripts to be first in <head>.

The CMP also supports manual blocking instead of automatic, where only annotated scripts can be blocked.

Analytics and reporting

The banner reports analytics events every time it is displayed, dismissed, or a consent change occurs. These events flow into the MineOS portal and become available in your dashboard within a few hours. This is how you track consent rates, measure banner performance, and compare A/B variants - there's no separate analytics integration required.

SEO and bot detection

The CMP automatically detects bots and crawlers (such as Googlebot and Bingbot) and skips its logic for them. This prevents consent banners from interfering with how search engines render and index your pages.

Getting started

Step 1: Create a website in the MineOS portal

In the MineOS portal, create a website for the site you want to add the CMP to and configure the domains it should apply to. As soon as you add the domains, MineOS begins scanning them to detect and classify cookies automatically.

Step 2: Set up your branding

Before creating banners, set up your branding in the dedicated branding page in the MineOS portal. This is where you configure colors, fonts, button styling, and other visual settings so that every banner you create matches your brand's look and feel.

Setting up branding first means you don't have to restyle each banner individually as you build out your configuration.

Step 3: Create banners from the gallery

When you create a banner, the banner gallery opens with pre-configured templates for the major privacy regulations (GDPR Opt-in, Opt-out, Soft opt-in, Notice only). Pick the template that matches the audience you're targeting and customize the copy, categories, and behavior from there.

If you serve visitors across multiple jurisdictions, create one banner per regulation — you'll wire them up to specific regions in the next step.

Step 4: Configure rules

Add rules to your website to decide which banner shows under which conditions. Rules match on geo location and URL, and they're evaluated in priority order, so put the most specific rules at the top.

A typical setup might be: a GDPR banner for EU visitors, a CCPA banner for California visitors, and a notice-only banner for everyone else.

Step 5: Publish and add the CMP scripts to your site

Publish the website in the MineOS portal — this generates the configuration file your site will load.

Then add the two CMP <script> tags to your site's <head>. These must be the first scripts in <head> and must not use async or defer — this is what ensures blocking activates before any other scripts on the page run.

The MineOS portal provides the exact snippet for your published website, including the correct configuration URL.

Step 6: Verify the installation

Load your site and confirm the banner appears as expected for the rule you want to test. If something looks off, the Testing, Debugging & Troubleshooting article covers the URL parameters and common issues you can use to diagnose the problem.

Step 7: Add a "Cookie Settings" link

Most sites need a persistent way for visitors to reopen the banner after they've made a choice — typically a "Cookie Settings" or "Privacy Preferences" link in the footer. The JavaScript SDK provides a method to open the banner on demand for exactly this purpose.

This step is required if you're using a Soft Opt-in banner configured to not auto-display, since in that case the link is the only way for visitors to reach their preferences.