---
title: Identity API
description: How you can use the Identity API to share reader-provided data with ad partners
---

[Skip to content](https://help.mediavine.com/identity-api#main-content)

English

Show submenu for translations

[![mediavine-horiz-white-pn-RGB-(r)-spacing](https://help.mediavine.com/hs-fs/hubfs/Logos/Mediavine%20Logos/mediavine-horiz-white-pn-RGB-(r)-spacing.png?width=385&height=100&name=mediavine-horiz-white-pn-RGB-(r)-spacing.png)](https://www.mediavine.com/)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- [Go to mediavine.com](https://www.mediavine.com/)

[Go to mediavine.com](https://www.mediavine.com/)

 Advice and answers from Mediavine!

- There are no suggestions because the search field is empty.

1. [Help Center](https://help.mediavine.com/?hsLang=en)
2. [Advanced](https://help.mediavine.com/advanced?hsLang=en)

# Identity API

## How you can use the Identity API to share reader-provided data with ad partners

### Mediavine Identity API

The Mediavine Identity API is a public facing API that enables publishers to provide user-provided data to our partners. It is an asynchronous API that is available after the `mediavineIdentityReady` occurs.

### Event: `mediavineIdentityReady`

The `mediavineIdentityReady` event occurs after the publicly available Mediavine Identity API methods are exposed on the `window` object. Once this event occurs, the identityOptIn and identityOptOut methods are ready to be used. These Mediavine Identity API methods are explained in detail below.

### Method 1:  `window.$adManagementConfig.web.identityOptIn(data, callback)`

The `window.$adManagementConfig.web.identityOptIn` method accepts two arguments, an object `data` and a function `callback` which are explained in detail below.

#### Object: `data`

The `data` object must contain the key `email` with a value that is a string representing a valid email address or a valid email address in a plaintext or **SHA-256**hex-encoded format:

plain text

```
{ email: 'johnsmith@website.com' }
```

SHA-256 hex-encoded equivalent of the above

```
{ email: 'f8d5da18dd78c78c4fc81dc136f31e885d5722297501f0bd17f92347c6393357' }
```

#### Function: `callback`

The `callback` function receives just one parameter, an Error object, if there was an error using the Mediavine Identity API. Else, it will return `null` when there is no error.

Example Usage

```
adManagementConfig
```

### Method 2: `window.$adManagementConfig.web.identityOptOut(callback)`

The `window.$adManagementConfig.web.identityOptOut(callback)` method accepts one argument, a `callback` function.

### Function: `callback`

The `callback` function receives just one parameter, an Error object, if there was an error using the Mediavine Identity API. Else, it will return `null` when there is no error.

Example Usage

```
adManagementConfig
```

- [Joining Mediavine Ad Management](https://help.mediavine.com/joining-mediavine-ad-management?hsLang=en#main-content)

    - [FAQ](https://help.mediavine.com/joining-mediavine-ad-management?hsLang=en#faq)
- [Launching your Mediavine Ads](https://help.mediavine.com/launching-your-mediavine-ads?hsLang=en#main-content)

    - [Mediavine Control Panel Wordpress Plugin](https://help.mediavine.com/launching-your-mediavine-ads?hsLang=en#mediavine-control-panel-wordpress-plugin)
    - [Installing the Mediavine Script on Non-Wordpress platforms](https://help.mediavine.com/launching-your-mediavine-ads?hsLang=en#installing-the-mediavine-script-on-non-wordpress-platforms)
- [Mediavine Publisher FAQ](https://help.mediavine.com/mediavine-publisher-faq?hsLang=en#main-content)

    - [Getting Started](https://help.mediavine.com/mediavine-publisher-faq?hsLang=en#getting-started)
    - [Site Sales](https://help.mediavine.com/mediavine-publisher-faq?hsLang=en#site-sales)
- [Payment Info](https://help.mediavine.com/payment-info?hsLang=en)
- [Dashboard FAQ](https://help.mediavine.com/dashboard-faq?hsLang=en#main-content)

    - [Getting Started](https://help.mediavine.com/dashboard-faq?hsLang=en#getting-started)
    - [Settings](https://help.mediavine.com/dashboard-faq?hsLang=en#settings)
    - [FAQ](https://help.mediavine.com/dashboard-faq?hsLang=en#faq)
    - [Troubleshooting](https://help.mediavine.com/dashboard-faq?hsLang=en#troubleshooting)
- [Site Health Checks](https://help.mediavine.com/site-health-checks?hsLang=en)
- [Standard Ad Units](https://help.mediavine.com/standard-ad-units?hsLang=en#main-content)

    - [Mediavine Ad Units](https://help.mediavine.com/standard-ad-units?hsLang=en#mediavine-ad-units)
    - [Ad Functionality](https://help.mediavine.com/standard-ad-units?hsLang=en#ad-functionality)
    - [Customizing your ad experience](https://help.mediavine.com/standard-ad-units?hsLang=en#customizing-your-ad-experience)
    - [AMP Ads](https://help.mediavine.com/standard-ad-units?hsLang=en#amp-ads)
    - [Troubleshooting](https://help.mediavine.com/standard-ad-units?hsLang=en#troubleshooting)
- [Site Specific Ad Units](https://help.mediavine.com/site-specific-ad-units?hsLang=en#main-content)

    - [Recipe Ads](https://help.mediavine.com/site-specific-ad-units?hsLang=en#recipe-ads)
    - [Interstitials](https://help.mediavine.com/site-specific-ad-units?hsLang=en#interstitials)
    - [Chicory](https://help.mediavine.com/site-specific-ad-units?hsLang=en#chicory)
    - [Sidebar Alternative](https://help.mediavine.com/site-specific-ad-units?hsLang=en#sidebar-alternative)
    - [Leaderboard](https://help.mediavine.com/site-specific-ad-units?hsLang=en#leaderboard)
- [Video](https://help.mediavine.com/video?hsLang=en#main-content)

    - [Mediavine Universal Player](https://help.mediavine.com/video?hsLang=en#mediavine-universal-player)
    - [Getting Started With Video](https://help.mediavine.com/video?hsLang=en#getting-started-with-video)
    - [Video Features](https://help.mediavine.com/video?hsLang=en#video-features)
    - [Mediavine Video + YouTube](https://help.mediavine.com/video?hsLang=en#mediavine-video-youtube)
    - [Closed Captions](https://help.mediavine.com/video?hsLang=en#closed-captions)
    - [Video Sitemaps](https://help.mediavine.com/video?hsLang=en#video-sitemaps)
    - [Playlists](https://help.mediavine.com/video?hsLang=en#playlists)
- [Optimize Your Ad Performance](https://help.mediavine.com/optimize-your-ad-performance?hsLang=en#main-content)

    - [Using Page-Level Data to Maximize Performance](https://help.mediavine.com/optimize-your-ad-performance?hsLang=en#using-page-level-data-to-maximize-performance)
    - [Tips to Maximize Ad Performance and RPM](https://help.mediavine.com/optimize-your-ad-performance?hsLang=en#tips-to-maximize-ad-performance-and-rpm)
    - [Sweet Land of Money Series](https://help.mediavine.com/optimize-your-ad-performance?hsLang=en#sweet-land-of-money-series)
- [Privacy](https://help.mediavine.com/privacy?hsLang=en#main-content)

    - [Privacy Policy](https://help.mediavine.com/privacy?hsLang=en#privacy-policy)
    - [State Privacy](https://help.mediavine.com/privacy?hsLang=en#state-privacy)
    - [GDPR](https://help.mediavine.com/privacy?hsLang=en#gdpr)
    - [LGPD Lei Geral de Proteção de Dados Pessoais](https://help.mediavine.com/privacy?hsLang=en#lgpd-lei-geral-de-prote%C3%A7%C3%A3o-de-dados-pessoais)
    - [US State Privacy Laws](https://help.mediavine.com/privacy?hsLang=en#us-state-privacy-laws)
- [Ad Quality](https://help.mediavine.com/ad-quality?hsLang=en)
- [SEO Help](https://help.mediavine.com/seo-help?hsLang=en)
- [Site Speed](https://help.mediavine.com/site-speed?hsLang=en)
- [Grow](https://help.mediavine.com/grow?hsLang=en#main-content)

    - [Getting Started](https://help.mediavine.com/grow?hsLang=en#getting-started)
- [PubNation](https://help.mediavine.com/pubnation?hsLang=en#main-content)

    - [Getting Started](https://help.mediavine.com/pubnation?hsLang=en#getting-started)
    - [PubNation Applications and Onboarding](https://help.mediavine.com/pubnation?hsLang=en#pubnation-applications-and-onboarding)
    - [Understanding the Tech](https://help.mediavine.com/pubnation?hsLang=en#understanding-the-tech)
    - [PubNation Ads](https://help.mediavine.com/pubnation?hsLang=en#pubnation-ads)
- [Products](https://help.mediavine.com/products?hsLang=en#main-content)

    - [Mediavine Labs](https://help.mediavine.com/products?hsLang=en#mediavine-labs)
    - [Create](https://help.mediavine.com/products?hsLang=en#create)
- [Advanced](https://help.mediavine.com/advanced?hsLang=en#main-content)

    - [Google Analytics](https://help.mediavine.com/advanced?hsLang=en#google-analytics)
    - [SSL / HTTPS](https://help.mediavine.com/advanced?hsLang=en#ssl-https)
    - [Ads.txt Help!](https://help.mediavine.com/advanced?hsLang=en#ads-txt-help)
- [Conflicts](https://help.mediavine.com/conflicts?hsLang=en#main-content)

    - [Cloudflare](https://help.mediavine.com/conflicts?hsLang=en#cloudflare)
    - [WP Rocket](https://help.mediavine.com/conflicts?hsLang=en#wp-rocket)
    - [Layout Conflicts](https://help.mediavine.com/conflicts?hsLang=en#layout-conflicts)
- [Mediavine Direct](https://help.mediavine.com/mediavine-direct?hsLang=en)
- [Perks & Programs](https://help.mediavine.com/perks-programs?hsLang=en)
- [Navigating the New Dashboard](https://help.mediavine.com/navigating-the-new-dashboard?hsLang=en)

[![mediavine-horiz-black-RGB-2-1](https://help.mediavine.com/hs-fs/hubfs/Logos/Mediavine%20Logos/mediavine-horiz-black-RGB-2-1.png?width=138&height=30&name=mediavine-horiz-black-RGB-2-1.png "mediavine-horiz-black-RGB-2-1")](http://mediavine.com)

mediavine.com Help Center

Copyright © 2026, © Mediavine, Inc.⎪All Rights Reserved