Sign in

v1

latestOpenAPI 3.1.22026-08-062227.3 KB
Contact Search

Search contacts

Submit a batch request to search business contacts.

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

Set A - addressline1, locality, administrativearea, postalcode

Set B - phonenumber

Set C - fullname / lastname / anyname / companyname, administrativearea

Set C - fullname / lastname / anyname / companyname, postalcode

post/docontactSearch

Headers

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

Format of the response.

Content-Type'application/json' required

Format of the request.

Request body

CustomerIDstring 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.

TransmissionReferencestring

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

AddressLine1string

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

AdministrativeAreastring

State, Province. The most common geographic data element.

Countrystring

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.

Localitystring

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

PhoneNumberstring

The phone number of the individual or company.

PostalCodestring

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

PremiseNumberstring

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

SubpremisesNumberstring

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

ThoroughfareNamestring

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

ThoroughfarePostdirectionstring

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

ThoroughfarePredirectionstring

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

ThoroughfareTrailingTypestring

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

AnyNamestring

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.

CompanyNamestring

The name of a business or corporation.

FirstNamestring

The first name of an individual.

FullNamestring

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

LastNamestring

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.

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.