# About the Consent Policy Manager API

The Consent Policy Manager API allows you to manage site visitor consent policies for GDPR and CCPA compliance.

Each site has a default consent policy assigned to all visitors. Visitors can customize their consent policy through cookie consent banners, overriding the default settings.

Use this API to:

- Get the current visitor's consent policy.
- Set a custom consent policy for a visitor.
- Reset a visitor's policy to the site default.
- Listen for consent policy changes.

Site owners can configure cookie consent banners in their site's privacy center.

Coding Examples

Sled Tests

Go Headless

Develop Websites (SDK)

Build Apps

Client (Deprecated)

API Preview

Wix CLI

Ricos

Develop Websites

API Reference

Velo

Picasso

GraphQL (Alpha)

Consent Policy Manager 

Gets the site visitor's consent policy regarding allowed cookies and 3rd-party data transfers for GDPR or CCPA compliance.

Retrieves the site visitor's consent policy details, including which cookies are allowed and whether data transfer to 3rd parties is permitted.

```typescript
import { consentPolicyManager } from '@wix/site';

const policyDetails = consentPolicyManager.getCurrentConsentPolicy();
const policy = policyDetails.policy;

```

Get a member's consent policy


getCurrentConsentPolicy

The current consent policy details, or undefined if not available

PolicyDetails

The function to run when the consent policy changes

handler

ConsentPolicyChangedHandler

Triggered when a site visitor's consent policy was changed using setConsentPolicy() or reset using resetConsentPolicy().

Use the onConsentPolicyChanged() method for code you want to run after the site visitor's current consent policy was changed.

```typescript
import { consentPolicyManager } from '@wix/site';

consentPolicyManager.onConsentPolicyChanged((event) => {
  const policy = event.policy;
  console.log(event);
});

// Full event object:
// {
//   "defaultPolicy": false,
//   "policy": {
//     "functional": false,
//     "analytics": true,
//     "advertising": false,
//     "dataToThirdParty": false,
//     "essential": true
//   }
// }
```

onConsentPolicyChanged

void

Removes the current policy from the site visitor's browser
and resets the site visitor's consent policy to the default policy for the site.

```typescript
import { consentPolicyManager } from '@wix/site';

const success = consentPolicyManager.resetPolicy();
```

Reset the current consent policy


resetConsentPolicy

boolean indicating if the consent policy was successfully reset, or undefined if not available

boolean

An object representing the cookies of the site visitor's consent policy.

policy

Policy

Optional callback function called on success with PolicyDetails

successCallback

SetConsentPolicySuccessCallback

Optional callback function called on error with error message

errorCallback

SetConsentPolicyErrorCallback

Sets the current site visitor's consent policy
regarding allowed cookies and data transfer to 3rd parties,
such as for GDPR or CCPA purposes.

Changes to the consent policy take affect after the page is refreshed.

```typescript
import { consentPolicyManager } from '@wix/site';

const policy = {
  essential: true,
  functional: true,
  analytics: true,
  advertising: false,
  dataToThirdParty: false,
};

const successCallback = (policyDetails: PolicyDetails) => {
  console.log(policyDetails);
};

const errorCallback = (error: string) => {
  console.log(error);
};

const policyDetails = await consentPolicyManager.setConsentPolicy(policy, successCallback, errorCallback);
console.log(policyDetails);
```

Set a member's consent policy


setConsentPolicy

Promise that resolves with the updated PolicyDetails when the consent policy is successfully set, or undefined if not available

consent-policy-manager

Consent for cookies used for advertising purposes. This includes 3rd-party scripts and pixels that may potentially place advertising cookies on the device. For example, Twitter page view and Facebook Pixel. Default: `true`.

advertising

Consent for cookies used for analytics, such as Wix analytics, Google Analytics, Yandex Metrica, and so on. Default: `true`.

analytics

Consent for a site visitor's personal data to be transferred to a 3rd party. For example, Google Analytics, Facebook Pixel, and FullStory. Default: `true`.

dataToThirdParty

Consent for mandatory cookies for Wix websites, such as for security cookies. Wix places these cookies on the site visitor's device. These cookies don't require site visitor consent. Always `true`.

essential

Consent for cookies placed on the site visitor's device that "remember" their user settings to improve user experience. For example, an indication that the user dismissed a popup. Default: `true`.

functional

The date the consent policy was set, if a cookie defining the current policy exists in the browser. Otherwise, it's undefined.

createdDate

Whether the current consent policy is the default one you set. If `true`, either the site visitor hasn't set a policy, or you've reset it to its default settings.

onConsentPolicyChanged( )