The Basics

Learn about the Retrieval API.

The Retrieval API is a secure, real-time interface that provides direct access to LiveRamp's Identity Graph.

When you use the Retrieval API to send personally identifiable information (PII) for a consumer, the API attempts to match that data to existing records in the LiveRamp Identity Graph. The Retrieval API responds with the RampIDs for each matched record, as well as other information about the match, such as how the match was performed.

The PII input data that you send can be plaintext or hashed. You can also send a RampID.

The responses are organized into response documents. For more information, see About Documents.

Response data is organized into response data bundles within each response document. For more information, see About Data Bundles.

You can also use the Retrieval API to decrypt identity envelopes. See About Identity Envelope Decryption for more information.

You can use the Retrieval API to transcode RampIDs from one partner encoding to another. See About RampID Transcoding for more information.

Retrieval API calls can be made only as batch request calls for multiple records.

Response data is returned in JSON.

The Retrieval API follows standard REST conventions and is secured using OAuth2.