> For the complete documentation index, see [llms.txt](https://docs.relevant-digital.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.relevant-digital.com/technical/integration/formats-and-channels/setting-up-and-working-with-the-prebid-user-id.md).

# Setting up and working with the Prebid User ID

Use Prebid User ID modules to work with supported identity vendors.

Configure each module at the global or site level.

### 1. Add a User ID module

First, add the identity vendor to your Prebid.js build.

1. Go to **Configuration → Integrations**.
2. Select **New User ID Module**.
3. Select the identity vendor.

<div data-with-frame="true"><img src="https://4674099.fs1.hubspotusercontent-na1.net/hubfs/4674099/Add%20new%20user%20id%20module-png.png" alt="Add a new User ID module"></div>

{% hint style="info" %}
Some vendors require credentials, such as a partner ID or custom URL. Obtain these from the vendor before configuration.
{% endhint %}

### 2. Enable and configure the module

Enable the module where it should apply. Use global settings for all traffic. Use site settings for a specific site.

1. Go to **HB Management → Global HB Management → Prebid parameters**.
2. Select **User ID Modules**.
3. Enable the module and enter its settings.

<div data-with-frame="true"><img src="https://4674099.fs1.hubspotusercontent-na1.net/hubfs/4674099/enable%20user%20id%20modules%20(1)-png.png" alt="Enable User ID modules"></div>

### 3. Configure module settings

Set the vendor fields and storage behavior for the enabled module.

| Setting                          | Description                                                                | Prebid.js equivalent       |
| -------------------------------- | -------------------------------------------------------------------------- | -------------------------- |
| **Required and optional fields** | Add vendor-specific credentials, such as a partner ID or key.              | `modules[].params`         |
| **Storage type**                 | Choose where the browser stores the ID, such as local storage or a cookie. | `storage.type`             |
| **Storage time**                 | Set how long the ID remains valid, in days.                                | `storage.expires`          |
| **Refresh interval**             | Set how often the module checks or generates an ID, in seconds.            | `storage.refreshInSeconds` |

Save the settings to activate the module for the selected scope.

### Vendor requirements

Review the [Prebid User ID sub-modules reference](https://docs.prebid.org/dev-docs/modules/userId.html#user-id-sub-modules) for supported vendors and required fields.

For other implementation options, see [Formats and channels](/technical/integration/formats-and-channels.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.relevant-digital.com/technical/integration/formats-and-channels/setting-up-and-working-with-the-prebid-user-id.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.