Sign in

ae2b8a54f1b4

latestOpenAPI 3.1.22026-08-061621.4 KB
Personator Search

Search individual person information

The service requires at least one of the following input combinations:

Set A - a1, postal

Set B - a1, city, state

Set C - ff

Set D - last

Set E - phone

Set F - email

Set G - mak

Set H - mik

get/doPersonatorSearch

Query parameters

tstring

Transmission reference - Serves as a unique request identifier.

format'JSON' | 'XML'

Desired format of the response.

{"stackTrail":"paths:/doPersonatorSearch:get:parameters:4:schema","oasType":"schema","type":"unknown"}

Required. The License Key issued by Melissa.

optstring

Options - List options in the following format, with multiple options delimited with a , (comma).

OptionName:Parameter,OptionName:Parameter

  • AgeRange:<# | #-#> - Sets the range of ages returned. Default will return all ages. If a record does not have a birth date or age, that record will not be returned.
  • MaxEmail:<0 - #> - Sets the maximum number of emails that can be returned. Default maximum is '3' if this option is not set.
  • MaxPhone:<0 - #> - Sets the maximum number of phone numbers that can be returned. Default maximum is '3' if this option is not set.
  • NameHint:<varying | definitelyfull | verylikelyfull | probablyfull | probablyinverse | verylikelyinverse | definitelyinverse | mixedfirstname | mixedlastname> - Sets the name hint for the input name. Default is 'varying'.
  • Page:<0 - #> - 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.
  • RecordsPerPage:<0 - #> - 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.
  • ReturnAllPages:<true | false> - Specifies whether to return all pages of results or just the first page.
  • SearchConditions:<strict | loose | batch | progressive> - Specifies the type of search conditions to use when returning records. Only the populated input fields will be compared. A 'strict' search condition is used by default.
  • SearchType:<AddressSearch | Auto | EmailSearch | NameSearch | PhoneSearch> - This options allows you to specify the type of search to perform. Default is 'Auto'.
  • ShowAllRecords:[None] - This options allows you to return historical/outdated information records that have not been verified in recent sources. While more information is returned, not all information may be as accurate.
  • SortBy:<AddressLine1-ascending | AddressLine1-descending | CityState-ascending | CityState-descending | DateOfBirth-ascending | DateOfBirth-descending | DateOfDeath-ascending | DateOfDeath-descending | FirstName-ascending | FirstName-descending | FullName-ascending | FullName-descending | LastName-ascending | LastName-descending | MelissaAddressKeyBase-ascending | MelissaAddressKeyBase-descending | MoveDate-ascending | MoveDate-descending | PostalCode-ascending | PostalCode-descending> - Allows sorting records in a particular order. If ascending or descending is not specified, the default order will be ascending.
colsstring

Columns - The column names or groups to be output

  • PreviousAddress - This returns as PreviousAddresses array containing previous address objects.
  • DateOfBirth - This field returns as part of the respective record object in the Records array.
  • DateOfDeath - This field returns as part of the respective record object in the Records array.
  • Email - This field returns as an EmailRecords array containing the email field.
  • MelissaIdentityKey - This field returns a unique key associated with a person.
  • MoveDate - This field returns as part of the CurrentAddress object.
  • Phone - This field returns as an PhoneRecords array containing the phoneNumber field.
  • Suffix - This field returns any part of the name that follows the family name.
a1string required

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.

ageapproxstring

Age approximate - Filter results to return individuals who are within a year of the provided age

agegtstring

Age greater than - Filter results to return individuals who’s age is greater than the provided age.

ageltstring

Age less than - Filter results to return individuals who’s age is less than the provided age.

bdaystring

The birth day for the record in DD format. Entering the Birth Day will filter results to return only when the day of birth matches.

bmonthstring

The birth month for the record in MM format. Entering the Birth Month will filter results to return only when the month of birth matches.

byearstring

The birth year for the record in YYYY format. Entering the Birth Year will filter results to return only when the year of birth matches.

citystring required

The city.

emailstring

The email address.

ffstring

Free Form Input - Accepts delimited or undelimited free form input. This will be parsed by the service.

firststring

The first name.

fullstring required

The full name.

laststring

The last name.

makstring

Melissa Address Key (MAK) - A proprietary unique key identifier for an address

mikstring

Melissa Individual Key (MIK) - A proprietary unique key identifier for an individual. Each individual is assigned a unique MIK number in the Melissa Personator Database.

phonestring

The phone number.

postalstring required

The postal code or zip code.

statestring required

The state name.

Headers

Accept'application/json' | '*/*' required

Format of the response.

Content-Type'application/json' required

Format of the request.

Response

Successful response.

TransmissionResultsstring

This is a string value that lists result codes from the web service. For more information, see Personator Search Result Codes.

TransmissionReferencestring

A pass-through of the input TransmissionReference field.

TotalPagesstring

This is a string value containing the number of total pages returned by the request. The amount of records per page is set within the RecordsPerPage option.

TotalRecordsstring

This is a string value containing the number of total records returned by the request, up to a maximum of 500.

Versionstring

This is a string value that is the current revision number of Personator Search web service.