Single request endpoint

Match Parameters Rules

The following list describes the general parameters rules.

All calls to the Match endpoint must contain one or more match parameters.
Match parameters must be included after the ? character in the URL request and formed as [parameter_name]=[parameter_value].
Separate multiple parameters using &.

Match Parameter Parsing

The parsed name (for example, firstName, middleName, and lastName) AND the unparsed name (for example, name) cannot be passed in the same request.
The parsed street address (for example, primaryNumber, street) AND the unparsed street address (for example, streetAddress) cannot be passed in the same request.
The parsed phone number (for example, areaCode, exchange, and subscriberNumber) AND the unparsed phone number (for example, phoneNumber) cannot be passed in the same request.
The limit match parameter cannot be set to less than 1.

Match Parameter Validation

Variable	Rule
state	Must be a two-character state abbreviation
zipCode	Must be five or nine digits
emailAddress	Must contain an @ character
ipAddress	Must be a valid IP address
areaCode	Must be three digits
exchange	Must be three digits
phoneNumber	Must be 10 digits
latitude and longitude	Must be valid a latitude and longitude

Match Parameter Combinations

Below are the most common input parameter combinations and the possible document types returned for each. Brackets [ ] around a parameter indicate the parameter is optional.

Input Parameter Combination	Document Types Returned
Name + Zip + [Zip4]	Household, Person
Name + Zip11	Household, Person, Place
Last Name + Street + Zip + [Zip4]	Household
Name + IP	Household, Person
Lat/Long	Household, Place - Postal
Street + City + State	Household, Place - Postal
Street + ZipCode	Household, Place - Postal
[Name] + Email	Entity, Household, Person, Place - Email • Impact for default cascade: In cases where there is an exact match on first or last name, Email only matches may now become Partial Name + Email. These matches will have a higher match confidence than touchpoint-only matches, and the nameMatchIntegrity value in the matchMetadata bundle will read partial, indicating that part of the name matched (but not the entire first & last name, that would be a Name+Touchpoint match).
[Name] + Phone	Entity, Household, Person, Place - Phone • Impact for default cascade: In cases where there is an exact match on first or last name, Phone only matches may now become Partial Name + Phone. These matches will have a higher match confidence than touchpoint-only matches, and the nameMatchIntegrity value in the matchMetadata bundle will read partial, indicating that part of the name matched (but not the entire first & last name, that would be a Name+Touchpoint match).
Name + Lat/Long	Entity, Household, Person, Place - Postal, Business
Email	Entity, Household, Person, Place - Email
Email+ ZipCode	Entity, Household, Person, Place - Email
Name + Street + City + State	Entity, Household, Person, Place - Postal, Business Note: This match will only work if there is only one possible zip for City/State.
Name + Street + [City] + [State] + ZipCode	Entity, Household, Person, Place - Postal, Business
Name + Street + IP	Entity, Household, Person, Place - Postal, Business
Name + Street + Lat/Long	Entity, Household, Person, Place - Postal, Business
Name + Street + Email	Entity, Household, Person, Place - Postal
Name + Street + [City] + [State] + [ZipCode] + Phone	Entity, Household, Person, Place - Postal, Place - Phone
Name + ZipCode + Email	Entity, Household, Person, Place - Postal, Place - Email
Name + Street + City + State + Email	Entity, Household, Person, Place - Postal, Place - Email