Personator Search:Request

← Personator Search

A request consists of a protocol to make a call to the service, detailing desired elements. The minimum required elements in a request are your Customer ID (License Key) and the fields listed as Required below.

The web service supports REST and JSON protocols.

Field Names

This is a list of the request field names and their protocol naming conventions.

Field Name	REST
Transmission Reference	t
License Key	id
Options	opt
Columns	cols
Free Form	ff
Full Name	full
First Name	first
Last Name	last
Address Line 1	a1
City	city
State	state
Postal Code	postal
Phone Number	phone
Email Address	email
Melissa Address Key (MAK)	mak

Request Elements

The following elements set the basic options for each request. These apply to the entire request, not the individual records.

Transmission Reference

Optional.

This is a string value that serves as a unique identifier for this set of records. It is returned as sent.

Protocol	Syntax
REST	?t = string

License Key

Required.

This is a string value containing the License Key issued to the customer by Melissa Data for the web service.

If this element is absent, the web service will return an error. To receive a License Key, please contact your Melissa Data sales representative at 1-800-MELISSA.

Protocol	Syntax
REST	&id = string

Options

Optional.

Specifies the options. See the options below for more information.

Protocol	Syntax
REST	&opt = string

List options in the following format, with multiple options delimited with a ",".

Syntax
OptionName:Parameter,OptionName:Parameter

MaxEmail

Sets the maximum number of emails that can be returned. Default maximum is "3" if this option is not set.

Option Name	Parameter	Description
MaxPhone	# [0 - #]	Default set to 3. Sets the maximum number of emails to be returned.

MaxPhone

Sets the maximum number of phone numbers that can be returned. Default maximum is "3" if this option is not set.

Option Name	Parameter	Description
MaxPhone	# [0 - #]	Default set to 3. Sets the maximum number of phone numbers to be returned

Page

Specifies which "page" to return for a given request. Your "page" length is set by RecordsPerPage.

If your request returns more than your RecordsPerPage, these records will be split into "pages". Use this option to select which "page" to view. If your specified "page" is out of the range of possible "page" numbers, an error will be returned.

This option is ignored if the option ReturnAllPages is set to "true".

Option Name	Parameter	Description
Page	# [0 - #]	Specifies which "page" to return.

RecordsPerPage

Specifies how many records are in a "page". The default value is 5.

This option is ignored if the option ReturnAllPages is set to "true".

Option Name	Parameter	Description
RecordsPerPage	# [0 - #]	Default set to 5. Sets the records per "page".

ReturnAllPages

Option Name	Parameter	Description
ReturnAllPages	true	Will return all records up to a limit of 500.
	false	Default. Will not return all records.

SearchConditions

Specifies the type of search conditions to use when returning records. Only the populated input fields will be compared. A loose search condition is used by default.

Option Name	Parameter	Description
SearchConditions	exact	The input values should match the output values exactly.
	loose	Default. No filtering will be done. Raw record results will be returned.

SearchType

This options allows you to specify the type of search to perform.

Option Name	Parameter	Description
SearchType	Auto	Default. Performs name, address, email, and phone searches until one or more matches are found.
	NameSearch	Uses name data as the primary pivot when verifying or appending information.
	AddressSearch	Uses address data as the primary pivot when verifying or appending information.
	EmailSearch	Uses email data as the primary pivot when verifying or appending information.
	PhoneSearch	Uses phone data as the primary pivot when verifying or appending information.

SortBy

Allows sorting records in a particular order.

If ascending or descending is not specified, the default order will be ascending.

Option Name	Parameter	Description
SortBy	PostalCode-ascending PostalCode-descending	Sort by postal code. Plus4 is also included with the ordering.
	CityState-ascending CityState-descending	Sort by state then city.
	AddressLine1-ascending AddressLine1-descending	Sort by address line 1.
	FullName-ascending FullName-descending	Sort by full name.
	FirstName-ascending FirstName-descending	Sort by first name.
	LastName-ascending LastName-descending	Sort by last name.
	DateOfBirth-ascending DateOfBirth-descending	Sort by date of birth.
	DateOfDeath-ascending DateOfDeath-descending	Sort by date of death.
	MoveDate-ascending MoveDate-descending	Sort by move date.
	MelissaAddressKey-ascending MelissaAddressKey-descending	Sort by Melissa Address Key.
	MelissaAddressKeyBase-ascending MelissaAddressKeyBase-descending	Sort by Melissa Address Key Base.

Columns

Optional.

Specifies which column(s) to be output as a column delimited string.

Protocol	Syntax
REST	&cols = string

Entering the column name will return the column. Specifying a group name will return all columns in the group.

Field Name	Default Group	Groups	GrpAll
FullName	[DEFAULT] Returned by default.	N/A	GrpAll
FirstName
LastName
AddressLine1		PreviousAddress
Suite
City
State
PostalCode
Plus4
MelissaAddressKey
MelissaAddressKeyBase
Phone	N/A	Phone
Email		Email
MoveDate		MoveDate
DateOfDeath		DateOfDeath
DateOfBirth		DateOfBirth

Free Form

Optional.

Accepts delimited or undelimited free form input. This will be parsed by the service.

Protocol	Syntax
REST	&ff = string

Full Name

Recommended.

The full name.

Protocol	Syntax
REST	&full = string

First Name

Optional.

The first name.

Protocol	Syntax
REST	&first = string

Last Name

Optional.

The last name.

Protocol	Syntax
REST	&last = string

Address Line 1

Optional.

The input field for the address. This should contain the delivery address information (house number, street, building, suite, etc.) but should not contain locality information (city, state, postal code, etc.) which have their own inputs.

Protocol	Syntax
REST	&a1 = string

City

Optional.

The city.

Protocol	Syntax
REST	&city = string

State

Optional.

The US state.

Protocol	Syntax
REST	&state = string

Postal Code

Optional.

The postal code.

Protocol	Syntax
REST	&postal = string

Phone Number

Optional.

The phone number.

Protocol	Syntax
REST	&phone = string

Email Address

Optional.

The email address.

Protocol	Syntax
REST	&email = string

Melissa Address Key (MAK)

Optional.

A propietary unique key identifier for an address.

Protocol	Syntax
REST	&mak = string