Ready to start using the Retrieval API? The API Reference includes information to use the Retrieval API endpoints, including parameters and responses.

This API Reference documentation includes the information that you need to use the Retrieval API including information about how to request an access token and how to resolve your PII data using the Match endpoint and the Lookup endpoint endpoints.

The Retrieval API allows you to resolve your data to individuals. API calls are made using batch requests, which allow you to send up to 1000 records per call.

The Retrieval API Process

  1. Request an access token.
  2. Send your PII-based consumer data such as name, address, phone number, or email address to a Retrieval API Match or Lookup endpoint.

📘

The process works slightly differently when calling the API to transcode RampIDs or to decrypt identity envelopes.

  1. The API processes the request and then returns the applicable RampIDs along with any requested associated metadata:
    If a matching record is found in the LiveRamp Identity Graph, the API returns a maintained RampID.
    If a matching record isn't found, the API returns a derived RampID for each PII touchpoint.