Using Identifiers in OpenRTB

Once you have successfully obtained Envelopes and used them to generate identifiers with the Sidecar, you will need to add them to your outgoing bid requests for supported demand platforms.

OpenRTB 2.5

"user": {
  "buyeruid": "example_buyer",
  "id": "example_id",
  "ext": {
    "eids": [{
      "source": "liveramp.com",
      "uids": [{
        "id": "XY1000bIVBVah9ium-sZ3ykhPiXQbEcUpn4GjCtxrrw2BRDGM"
      }]
    },
     {
      "source": "uidapi.com",
      "uids": [{
        "id": "AgAAAAPHpn5cHG8VyP6CAuHh5AMemVXXXxMdVzjhmdRl0nt8cglqmMRWTmKap05HIeNpLvEaAERX2mLp0RVSJz0M48igDHx53dsrnaenCAG/VDTJcAkHFLIplzOFjYASu0wtXsJ3IBNAWjSABjs7xmEXq73B16HRZAeCCBBKGBdvhp0rww=="
      }]
    }]
  }
}

Envelope are provided in the same format, except substituting the Envelope value in the LiveRamp uids.id source. Envelopes are typically sent when sending ad requests to other exchanges/SSPs, who operate their own Sidecar instance.

"user": {
  "buyeruid": "example_buyer",
  "id": "example_id",
  "ext": {
    "eids": [{
      "source": "liveramp.com",
      "uids": [{
        "id": "AvAPLiE-oU_cYmbXgyM0YCOXEnRg489A51pX2uvjoZx5f8V_1yzB_nkAQ5wICpnk2s_Iw1MvC0DL2sqkbzbtJSbEy9IWp5AYnJcL"
      }]
    }]
  }
}

A LiveRamp RampID will match the regular expression like ^(XY|Xi)\d{4}(.{43}|.{64})$ due to its predictable syntax, whereas an envelope will not.

Some use cases (e.g. CTV) call for multiple identifiers in a single bid request, but typically only one ID is provided in the uid array.

OpenRTB 3.0

"user": {
  "id": "aaa",
  "buyerid": "xxx",
  "eids": [
    {
      "source": "liveramp.com",
      "uids": [
        { "id": "XY1000bIVBVah9ium-sZ3ykhPiXQbEcUpn4GjCtxrrw2BRDGM", 
         "atype": 3 }]
    }
  ]
}