v1

latestOpenAPI 3.1.02026-08-062526.3 KB
Business Validation

Validate and retrieve business information.

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

Set A - a1, city, state, postal

Set B - ff

Set C - phone

Set D - stock

Set E - web

get/doBusinessCoderUS

Query parameters

tstring

Transmission Reference - Serves as a unique identifier for this set of records. This allows you to match a response to a request.

idstring required

Required. The License Key issued by Melissa.

colsstring

Columns - The column names or groups to be output.

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

Delimit multiple columns with a ,.

For example: ColumnName,ColumnName.

  • [DEFAULT] These columns are returned by default.
    • AddressLine1
    • City
    • CompanyName
    • CurrentCompanyName
    • MelissaEnterpriseKey
    • PostalCode
    • RecordID
    • Records
    • State
    • Suite
    • TotalContacts
    • TransmissionReference
    • TransmissionResults
  • [NO GROUP] These columns must be requested individually.
    • Contacts
    • EmployeesEstimate
    • LocationType
    • Phone
    • SalesEstimate
    • StockTicker
    • WebAddress
  • GrpAddressDetails
    • CountryCode
    • CountryName
    • DeliveryIndicator
    • MelissaAddressKey
    • MelissaAddressKeyBase
    • Plus4
  • GrpBusinessCodes
    • EIN
    • NAICSCode1
    • NAICSCode2
    • NAICSCode3
    • SICCode1
    • SICCode2
    • SICCode3
  • GrpBusinessDescription
    • NAICSDescription1
    • NAICSDescription2
    • NAICSDescription3
    • SICDescription1
    • SICDescription2
    • SICDescription3
  • GrpGeoCode
    • Latitude
    • Longitude
  • GrpCensus
    • CensusBlock
    • CensusTract
    • CountyFIPS
    • CountyName
    • PlaceCode
    • PlaceName
optstring

Options - Pass in options you want to set for the request.

List options in the format OptionName:Parameter, with multiple options delimited with a ,. For example: OptionName:Parameter,OptionName:Parameter

  • CentricHint:< company | address | phone > - This option allows you to choose what the service will center the search around.
  • MaxContacts:< 1 | 5 | 10 > - This option changes the upper limit on the number of contacts returned. Default is 5.
  • ReturnDominantBusiness:< yes | no > - This option handles the returning of the dominant business name and demographics for a particular site when the company information is missing or does not match. Default is yes.
  • SICNAICSConfidence:< strict | loose > - This option handles how SIC Codes are returned, depending on our SIC Code confidence level. Default is loose.
recstring

Record ID - Unique identifier for current record

compstring required

Company Name - Business namespace

phonestring required

Phone Number - Business phone number

a1string required

Address1 - First address line

a2string

Address2 - Second address line (suite)

suitestring

Suite - Suite number

citystring required

City - City name

statestring required

State - State name

postalstring required

Postal - Postal code

ctrystring

Country - Country name

makstring

Melissa Address Key (MAK) - Proprietary unique key identifier

stockstring

Stock Ticker - Unique stock exchange symbol/abbreviation

webstring

Web Address - Web address/domain

mekstring

Melissa Enterprise Key (MEK) - Proprietary unique key identifier

ffstring

Free Form

Headers

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

Format of the response.

Content-Type'application/json' | '*/*' required

Format of the request.

Response

A response is the result of a request. This consists of returned results codes and parsed, corrected, and/or appended request elements, depending on the options selected.

TransmissionResultsstring required

Returns the generic service level result/error codes. For more information, see Business Coder Result Codes.

TransmissionReferencestring required

A pass-through of the input Transmission Reference.

Versionstring required

The current service version number.

TotalRecordsstring required

Total number of records returned in the records array.

All 2 operations