Use the Match endpoint to match multiple raw PII records in one call.

Match Parameter Rules

The following list describes the general parameter rules.

  • Each URL string must start with "/people/match?".
  • Match parameters must be included after the ? character in the URL string and formed as [parameter_name]=[parameter_value].
  • Separate multiple parameters using &.
  • All calls to the Match endpoint must contain one or more match parameters in each URL string.

Match Parameter Parsing Guidelines

  • Do not include the parsed name (for example, firstName, middleName, and lastName) AND the unparsed name ( name) in the same request.
  • Do not include the parsed street address (for example, primaryNumber, street) AND the unparsed street address (streetAddress) in the same request.

Match Parameter Validation

Variable

Rule

state

Must be a two-character state abbreviation

zipCode

Must be 5, 9, or 11 digits

email

Must contain an @ character and must contain a period (".") in the domain portion

phone

Must be 10 digits with no special characters

limit

Must be an integer from 1 to 10

Match Parameter Combinations

Below are the most common input parameter combinations. Brackets ("[ ]") around a parameter indicate the parameter is optional.

Input Parameter Combination

Name + Street + [City] + [State] + ZipCode

Name + Email

Name + Phone

Email

Phone

Name + ZipCode

Language
Authentication
OAuth2