Retrieving and passing the LiveRamp identifier

When an encrypted envelope containing the user's LiveRamp identifier, IdentityLink (IDL), can be retrieved from the user's local storage or from LiveRamp's endpoint for the current page load, the IX Library passes the encrypted envelope to certified bidding adapters as part of the returnparcels parameter to the generateRequestObj function.

The generateRequestObj function is located in each adapter's module file, <adapter-name>-htb.js. For more information on the adapter code structure, see your <adapter-name>-htb.js file in GitHub. Within the generateRequestObj function, the identity object can be found at returnParcels[].identityData.LiveRampIp and provides the following identity data:

Location in identity object Field Description



The LiveRamp domain.



The user identifier string from LiveRamp's encrypted envelope.
uids.ext rtiPartner LiveRamp's ID.


    "data": {
	 "source": "",
        "uids": [
	          "id" "uid123"
                 "ext":" {
                      "rtiPartner": "idl"

Note: If your adapter architecture is set to Single Request Architecture (SRA), you will see that all elements in returnParcels[] contain identical identityData.LiveRampIp objects. You may use any of these elements to retrieve the IDL.

To decrypt the encrypted envelope that contains the IDL, your bidding adapter endpoint must support the LiveRamp Sidecar application. The value in the encrypted envelope changes every 24 hours.

Updating your adapter

Bidding adapters that want to pass the IDL to eligible DSPs must update their adapter code by following the standard certification process. For more information on updating your adapter, see Update a certified adapter.