v1

latestOpenAPI 3.1.02026-08-062526.3 KB

Business Validation

Validate and retrieve businesses information

Submit a batch request to validate and retrieve businesses information.

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

Set A - a1, city, state, postal

Set B - freeform

Set C - phone

Set D - stock

Set E - web

post/doBusinessCoderUS

Headers

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

Format of the response.

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

Format of the request.

Request body

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

idstring required

Required. The License Key issued by Melissa.

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.

tstring

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

Example request

{
  "cols": "GrpAddressDetails,GrpBusinessCodes",
  "opt": "CentrictHint:company,MaxContacts:5",
  "Records": [
    {
      "a1": "22382 Avenida Empresa",
      "city": "Rancho Santa Margarita",
      "comp": "Melissa Data",
      "ctry": "US",
      "phone": "8006354772",
      "postal": "92688",
      "state": "California"
    }
  ],
  "t": "Business Coder Test"
}

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.