Getting Started

The RampID API is a secure, real-time interface that provides direct access to LiveRamp's Identity Graph identity resolution. It has three components:

• The RampID Retrieval API
• The Identity Envelope Decryption API
• The RampID Translation API

Retrieving RampIDs

Identity resolution is the process of resolving your data to a specific individual. The process matches personal identifiers (such as a name, address, phone, and email) to digital identifiers (such as an IP address, cookie, or location), across multiple devices and channels. The RampID Retrieval API uses sophisticated machine learning algorithms and a patented process to then map that personal and digital information to a unique identifier in the LiveRamp Identity Graph. This unique identifier is called a RampID.

The Retrieval API provides two primary endpoints for perform known-to-pseudonymous identity resolution:

• The Match Endpoint is used for plaintext PII. This endpoint attempts to match the individual components of the input data to various combinations of RampID data and can return multiple RampIDs per request.
• The Lookup Endpoint is used when you don't want to send plaintext PII. This endpoint performs a direct lookup against a single input string (it does not attempt to match alternate combinations of data) and returns only one RampID per request.

Calls to either endpoint return response documents, with the different categories of information returned contained in response data bundles.

Decrypting Identity Envelopes

An Identity envelope is an opaque and encrypted structure containing RampIDs and metadata. Each envelope is created with a client-specific encryption key that makes it unique. The Identity Envelope Decryption Endpoint allows you to decode and decrypt an envelope to extract the data.

Translating RampIDs

Every RampID has a specific encoding to ensure the security and privacy of our partner's data. You can use the RampID Translation Endpoint to translate RampIDs from one partner encoding to another.