The Retrieval API Developer Hub

The Retrieval API allows you to match your data to the LiveRamp Identity Graph and receive RampIDs. API calls are made using batch request calls that contain up to 1000 records per call.

Guides    API Reference

RampIDs

Learn about the RampIDs returned for API calls, including ID versions and ID formats.

RampIDs are pseudonymous identifiers that are tied to a record in the LiveRamp identity graph. They allow you to identify and consolidate records across multiple systems. When you make API calls with two distinct sets of PII, and the API reconciles them to the same entity, then the same RampID is returned for each request.

You can structure the API call to return only the best match for the input data, or you can choose to receive multiple identifiers for input data that matches to multiple identifiers.

When the RampID is returned, you don't see the underlying ID, only a version of the ID. A Client Domain identifier will have a different value for each client even if the underlying LiveRamp Domain identifier is the same. This aids client privacy and reduces the probability of collusion.

RampID Types

There are two types of RampIDs:

  • A RampID represents an individual.
  • A Household RampID represents adults living together at the same location who exhibit a persistent relationship.

RampID Versions

There are two versions of RampIDs:

  • Maintained versions (when we have a persistent match for the input data)
  • Derived versions (when we do not have a persistent match for the input data)

Maintained Versions

When you make an API call and there is a match in the AbiliTec Identity Graph, a maintained RampID is returned. Maintained RampIDs start with "XY" and are 49 characters long.

This version of a RampID is maintained and is persistent.

Maintained RampIDs can change over time, due to new information being added to the identity graph. Running your data through the API allows you to update the maintained RampIDs for records that have changed.

Derived Versions

When you make an API call and there isn't a match in the Identity Graph, a derived RampID version is returned. Derived RampIDs start with the prefix “Xi” and are 70 characters long.

RampIDs that are derived versions are algorithmically derived and persistent—if you input the exact same PII string, the response will show the same derived RampID. Derived RampIDs are not maintained in the identity graph.

Derived versions are returned so that there is an identifier for every record. Because they are algorithmically derived, the exact same input data must be sent to receive the same derived ID.

A derived RampID can be updated to a maintained RampID as new data is added to the identity graph. Running your data through the API allows you to update the derived RampIDs for records that have changed.

Updated 3 months ago

RampIDs


Learn about the RampIDs returned for API calls, including ID versions and ID formats.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.