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

Data That is Returned

Learn about the data that's returned, including RampIDs and match metadata.

Depending on the endpoint you call and the included parameters, the Retrieval API returns the following data:

  • RampIDs—Identifiers that allow you to identify and consolidate records across multiple systems.
  • Match Metadata—When the Match endpoint is used, information about the components that were used to obtain the match, the matching level of the match cascade, and whether any components were invalid.

RampIDs

RampIDs are identifiers that are tied to a record in the LiveRamp Identity Graph. They allow you to identify and consolidate records across multiple systems.

You can make a call to return only the best match for the input data, or you can choose to receive multiple identifiers (for calls to the Match endpoint).

For more information about RampID types, versions, format, and structure, see "RampIDs".

Match Metadata

Match metadata is returned when you send data to the Match endpoint. Match metadata includes information related to the matching process. This information can help optimize data collection through improved understanding of which data types or PII types yield the best results.

Match metadata includes the following:

  • The match level in the match cascade (the “matchConfidence” parameter).
  • The input components that contributed to the match (the “matchComponents” parameter).
  • Whether there are additional maintained RampIDs associated with the components of the input data that were used for the match (the “distinctMatch” parameter).
  • Whether part or all of the major name components were used to obtain the match (the “nameMatchIntegrity” parameter).
  • Whether any components of the input data are invalid, such as an email address that is not in a valid format (the “invalidParameters” parameter).

Match Level

Components Matched

1

Name + Address + ZIP

2

Name + Email

3

Name + Phone

4

Partial Name + Email

5

Partial Name + Phone

6

Email

7

Phone

8

Name + ZIP

See "Metadata Bundles" for more information.

Updated 3 months ago

Data That is Returned


Learn about the data that's returned, including RampIDs and match metadata.

Suggested Edits are limited on API Reference Pages

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