v1

latestOpenAPI 3.1.22026-08-062227.3 KB
Contact Search

Search for a contact

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

Set A - a1, loc, adminarea, postal

Set B - phone

Set C - full / last / anyname / comp, adminarea

Set C - full / last / anyname / comp, postal

get/docontactSearch

Query parameters

idstring required

Required. The License Key issued by Melissa.

matchlevelstring

0-100. The weighted percentage of how close the query matches the returned record. Anything less than 80% is questionable.

maxrecordsstring

The maximum number of records to return.

tstring

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

a1string

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.)

adminareastring required

State, Province. The most common geographic data element.

ctrystring

The suspected country of the input phone number as the official country name or the ISO2 code. Some territories will require a different ISO2 code than the one that is given to them.

locstring

City, Municipality. The most common population center data element.

phonestring

The phone number of the individual or company.

postalstring

ZIP, Postcode. The complete postal code for a particular delivery point.

premnumstring

Street Number. Alphanumeric indicator for the most common street or block data element.

subpremnumstring

Suite Number. The Sub premises alphanumeric indicator for the most common street or block data element.

tnamestring

Street Name. Name indicator for the most common street or block data element.

postdirstring

Street Post Direction. The postfix directional for the most common street or block data element.

predirstring

Street PreDirection. The prefix directional for the most common street or block data element.

trailingtypestring

Street Suffix. The trailing thoroughfare type indicator for the most common street or block data element.

anynamestring required

Either an individual's name or a company name. It's better to use the Company Name or Full Name input fields if you know for sure.

compstring

The name of a business or corporation.

firststring

The first name of an individual.

fullstring

The full name of an individual. Inverse name order is also accepted (Smith Tim vs. Tim Smith).

laststring

The last name of an individual.

subuserstring

The Sub User ID. This is used to identify a group or users for multiple users/seats for logging purposes.

Headers

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

Format of the response.

Content-Type'application/json' required

Format of the request.

Response

Successful response

TransmissionReferencestring

Serves as a unique request identifier.

Versionstring

The current service version number.

ResultCodestring

Comma delimited status, error codes, and change codes for the request.

TotalRecordsstring

Total number of records.