Skip to content

added example of optout response #992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ssundahlTTD wants to merge 2 commits into
base: main
Choose a base branch
from
Open

added example of optout response #992

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc0a10b
added example of optout response
ssundahlTTD Feb 18, 2026
3cb9420
exmaple of decoded uid2 userId
ssundahlTTD Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/guides/integration-prebid-client-side.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,23 @@ pbjs.setConfig({

It is possible that the user has opted out of UID2 previously. In this case, the UID2 module respects the user's optout and no UID2 token is generated and collected by Prebid.js.

The response for a user that has opted out can be seen below:

```json
{
identity: 'optout',
status: 'optout'
}
```

The decoded UID2 userId object will look like:

```json
uid2: {
optout: true
}
```

## Checking the Integration

To check that the UID2 module has successfully generated a UID2 token, call `pbjs.getUserIds().uid2`. If a value is returned, a valid UID2 token exists in the UID2 module.
Expand Down
Loading