Use the Translation endpoint to translate RampIDs from one partner encoding to another.

📘

RampID translation was formerly known as "RampID transcoding". You might continue to see instances of "transcode", "transcoding", and "transcoded" in some places.

🚧

Every RampID has a specific encoding to ensure the security and privacy of our partner's data. Due to the sensitive nature of RampIDs, certain privacy restrictions must be validated before translation access is provided. To enable this feature, contact your LiveRamp representative.

The API translates RampIDs from one partner encoding to another, enabling each partner to maintain control of their unique RampIDs in a secure collaboration.

Calls to translate RampIDs can be made as a single transaction call (for a single RampID) or as a batch request call (to translate up to 1,000 RampIDs per call). We recommend you use batch requests whenever possible.

RampID Structure

Each RampID consists of three parts:

  • The two-letter prefix, which denotes whether the RampID is maintained ("XY" for individuals and "HY" for households) or derived ("Xi" or "Hi" for households);
  • The four-digit partner encoding (sometimes abbreviated to just "encoding"), which uniquely identifies the partner;
  • The unique value which identifies the person or household.

Visual breakdown of RampID parts into prefix, partner encoding, and unique ID value

The default encoding for the RampIDs that you receive is called your "native encoding".

Other-to-Native Translation

When you receive RampIDs in encodings that are different from your default, you translate them to your native encoding. Each partner encoding you would like to translate from requires an explicit one-time authorization to be performed by our client support team.

Once this authorization is configured, you can send any RampID in any authorized encoding to the API and then call the /people/anonymousAbilitec/ endpoint (for individuals) or the /households/anonymousAbilitec/ endpoint (for households) to receive that specific RampID in your native encoding.

Native-to-Other Translation

📘

The ability to perform native-to-other translation requires proper authorization setup. Your LiveRamp representative will properly permission and provide partner encodings to you.

You can translate RampIDs from your native encoding to another entity's encoding by providing the partner encoding directly as a query parameter.

Requesting RampID Translation Permissions

Translation permissions depend on a two-way agreement between your company and the partner whose RampIDs you wish to translate. This agreement must explicitly consent to the translation while specifying the translation direction (native to other or other to native).

When you contact your LiveRamp representative about obtaining translation permissions, they will email both you and your partner to obtain this consent, cc:ing [email protected].

The email for the partner doing the translation will read:

Please confirm permission to translate Company A RampIDs into Company 
B RampIDs.  Once received, your permission may be revoked at 
any time via email to [email protected].

The email for the partner translated from will read:

 Please confirm permission to translate Company A RampIDs into Company B RampIDs.  
 Once received, your permission may be revoked at any time via email to 
 [email protected].

If you are translating both to and from a partner's RampIDs, you must obtain separate permission for each translation direction:

 Please confirm permission to translate Company A RampIDs into Company 
B RampIDs and to translate Company B RampIDs into 
Company A RampIDs.  Once received, your permission may be revoked at any time via 
email to [email protected].