Configure Consent Options

The list of consent notices displayed to the user and their options are controlled by the Consent section of the configuration file. Within this section, consent options may be defined for the privacy center page and for the resulting consent options page.

For the privacy center page

These fields define how the consent tile will appear in the Privacy Center:

Field	Description
`includeConsent`	Whether or not to include a consent tile in the privacy center
`title`	Title for the consent tile that describes.
`description`	A user-friendly description for the tile.
`description_subtext`	Additional, optional text you can display on the consent request modal, after the button has been clicked.
`icon_path`	Specify a URL to a public icon to override the default icon displayed.
`identity_inputs`	The list of personally identifiable information gathered to perform consent and whether or not it is required. (See: Custom identities)
`custom_privacy_request_fields`	A list of additional metadata that can be provided by the user that is included in the request. (See: Custom request fields)

For the consent options page

These fields define how consent options page will appear:

Field	Description
`title`	Title for the consent options page.
`description`	A user-friendly description for the consent options page.
`description_subtext`	Any additional paragraphs of text to display on the consent options page.
`policy_key`	A key that refers to the policy that will be used for this action.
`consentOptions`	A list of consent notices that should appear on the page.

For each consent option

These fields define how each consent option will appear:

Field	Description
`fidesDataUseKey`	The FidesLang (opens in a new tab) `data use` that is linked to this consent option.
`name` & `description`	User-friendly information about the consent option.
`url`	The URL where a user can view the consent notice.
`default`	If this consent preference is enabled (true) or disabled (false) by default.
`highlight`	Set whether or not this consent preference is highlighted.
`cookieKeys`	The data use that is represented within the preference cookie stored on the user's browser.
`executable`	Whether the user's consent choice should be propagated to connected third party integrations.

Example: opt-out consent

This is an example of a consent configuration that creates a tile in the Privacy Center and consent options page that allows users to Opt Out of Data Sales, Sharing, and

    "includeConsent": true,
    "consent": {
        "button": {
            "title": "Manage your consent",
            "description": "Manage your consent preferences",
            "description_subtext": [
                "In order to opt-out of certain consent preferences, we may need to identify your account via your email address. This is optional."
            ],
            "icon_path": "/consent.svg",
            "identity_inputs": {
                "email": "optional"
            }
        },
        "page": {
            "title": "Manage your consent",
            "description": "Manage your consent preferences, including the option to select 'Do Not Sell or Share My Personal Information'.",
            "description_subtext": [
                "When you use our services, you're trusting us with your information. We understand this is a big responsibility and work hard to protect your information and put you in control."
            ],
            "policy_key": "default_consent_policy",
            "consentOptions": [
                {
                    "fidesDataUseKey": "marketing.advertising",
                    "name": "Data Sales and Sharing",
                    "description": "We may use some of your personal information for behavioral advertising purposes, which may be interpreted as 'Data Sales' or 'Data Sharing' under regulations such as CCPA, CPRA, VCDPA, etc.",
                    "url": "https://example.com/privacy#data-sales",
                    "default": {
                        "value": true,
                        "globalPrivacyControl": false
                    },
                    "highlight": false,
                    "cookieKeys": [
                        "data_sales_and_sharing"
                    ],
                    "executable": false
                }
            ]
        }
    }

Privacy Requests Appearance