Use the Lookup endpoint when you don’t want to send raw PII in your API call. The Lookup endpoint allows you to retrieve an exact match to a single hashed PII touchpoint.
You can use the Lookup endpoint to send MD5-hashed email addresses, SHA256-hashed email addresses. SHA1-hashed email addresses, or SHA1-hashed PII strings.
If there is a maintained record associated with the input string or ID, the maintained RampID is returned.
If a maintained record is not associated with the input string or ID, a derived RampID is returned.
Sending Hashed PII Strings
In addition to hashed email addresses, the Lookup endpoint accepts SHA1-hashed PII strings as input. The following SHA1-hashed PII strings are supported:
- Phone
- Name + Email
- Name + PhoneNumber
- Name + ZipCode
Calls to the Lookup endpoint using a SHA1-hashed PII string as input only return a maintained identifier if the hashed string has an exact match against a maintained record in the Identity Graph. The Lookup endpoint does not perform any approximate or fuzzy string matching. While all fields in the construction of a hashed PII string are optional, the presence or absence of fields may affect the results returned.
Allowed Hash Types
If you're sending just email addresses as input, you can use SHA-1, MD-5, or SHA-256 hashing.
If you're sending any PII other than email addresses, you must use SHA-1 hashing.
Set the "lookup_type" parameter to the hash type used ("sha1", "md5", or "sha256").
General Construction Rules
The rules listed below apply to all PII string types.
- Strings must be UTF-8 encoded.
- If a field is empty, it should be excluded from the string.
- Separate fields with single spaces. Don't add additional spaces if you leave out a particular field.
- Convert all fields to lowercase before hashing.
- Phone number should be digits only with no special characters.
- Hyphens are allowed except in phone numbers.
- Remove all periods (.) from name and phone fields. Do not remove periods from email addresses.
Constructing Names
See the table below for information on the elements that can be included when constructing names.
| Name Element | Description | Example | Required? |
|---|---|---|---|
| First Name | The person's first name. | Eduardo Felicia | Yes |
| Middle Name | The person's middle name or middle initial. | Kyu k john j | No |
| Last Name | The person's last name. | Lopez Nguyen | Yes |
| Generational Suffix | The person's generational name suffix. | Jr Sr II | No |
Constructing Postal Addresses
Postal addresses may be constructed in the following ways
- Primary Number + Pre Directional + StreetName + StreetSuffix + PostDirectional + Unit Designator + SecondaryNumber + City + State + Zip
- Zip
Supported Inputs for Each Hash
See the table below for all supported variations of hash type and input type. The elements in brackets [] are optional.
| Hash Type | Input Type | Formula |
|---|---|---|
| MD-5 | ||
| SHA-256 | ||
| SHA-1 | ||
| SHA-1 | Phone | Phone |
| SHA-1 | Postal | Primary Number + PreDirectional + Street Name + Street Suffix + PostDirectional + Unit Designator + Secondary Number + City + State + Zip |
| SHA-1 | Name + Email | First + [Middle OR Middle Initial] + Last + [Generational Suffix] + Email |
| SHA-1 | Name + Phone | First + [Middle OR Middle Initial] + Last + [Generational Suffix] + Phone |
| SHA-1 | Name + Postal | First + [Middle OR Middle Initial] + Last + [Generational Suffix] + [Primary Number] + [PreDirectional] + [Street Name] + [Street Suffix] + [PostDirectional] + [Unit Designator] + [Secondary Number] + [City] + [State] + Zip |
For more information, see The Lookup Endpoint.