User.eids

Extended identifiers from identity providers, as an array of EID objects, each holding one or more IDs from a single source. Added in OpenRTB 2.6; earlier versions carried the same structure in user.ext.eids by convention.

Currentobject arrayOptionalSince 2.6-202204

Field facts

Path: user.eids
Object: User
Type: object array
Requirement: Optional
Added: OpenRTB 2.6-202204
Spec section: 3.2.20

How it is used

Universal IDs, hashed-email IDs, and publisher-provided IDs all travel here, each entry naming its provider in EID.source so buyers can pick the systems they support. Send only IDs the request's signals allow: an opt-out in regs.gpp, a TCF string without consent for the provider, or regs.coppa set to 1 should shrink or empty the array.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "user": {
    "eids": [
      {
        "source": "id-provider.example",
        "uids": [
          {
            "id": "XY1000000000000EXAMPLE",
            "atype": 3
          }
        ]
      }
    ]
  }
}

Common mistakes

Writing the array only at user.ext.eids on a 2.6 request. Buyers reading the standard path see nothing.
Sending placeholder entries, or entries without source or a UID id. RTBlint reports them, and many DSPs discard the whole array.

Version history

Added in OpenRTB 2.6-202204, and present in the latest snapshot. The table shows how each version's spec text types the field.

Versions	Type in the spec	Required	Deprecated
2.6-202204	Added in the first 2.6 release, published without a structured text archive; the 2.6-202210 republication is the first tagged text.
2.6-202210 to 2.6-202606	object array	No	No

Versioned rules that name this field

openrtb.2.6.network_channel_supplychain_eids OpenRTB 2.6 added network, channel, supply-chain, and extended-ID object families.

Related fields

Other User fields

For a walkthrough of the whole object, read User identity and EIDs.