Data You Can Send with the Retrieval API

Learn about types of input data accepted by the Retrieval API.

The table below lists the types of input data you can include when you use the RampID API.

Input DataEndpointData Returned
Plaintext PIIMatch
  • Maintained RampIDs
  • Derived RampIDs
  • Match Metadata
SHA-1-hashed PII strings (including hashed email addresses or hashed phone numbers)Lookup
  • Maintained RampIDs
  • Derived RampIDs
MD5-hashed email addressesLookup
  • Maintained RampIDs
  • Derived RampIDs
SHA-256-hashed email addressesLookup
  • Maintained RampIDs
  • Derived RampIDs
Identity envelopesIdentity Envelope Decryption
  • Maintained RampIDs
  • Derived RampIDs
RampIDsTranscoding
  • Maintained RampIDs
  • Derived RampIDs

📘

Notes on transmitting plaintext data to the Match endpoint

  • The Match endpoint uses the match cascade.
  • The match process may include associative data and location data to improve matching.
  • Names, street addresses, and phone numbers can either be sent parsed (broken down into their individual components) or unparsed, but not both in the same call.