Sign in

v1

latestOpenAPI 3.1.22026-08-065935.5 KB
Lookup From List

Lookup addresses from a list of possible targets

An HTTP POST is issued with the "ContentType" header specifying the format of the request and the "Accept" header specifying the format of the response.

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

Set A - Latitude, Longitude

Set B - MelissaAddressKey (Request Level Parameter)

post/doLookupFromList

Headers

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

Format of the response.

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

Format of the request.

Request body

CustomerIdstring required

Required. The License Key issued by Melissa.

Latitudestring required

Required. The latitude geographic coordinate in decimal format.

Longitudestring required

Required. The longitude geographic coordinate in decimal format.

MaxDistancestring

The requested maximum distance in miles. The maximum value is 10. Default is 10.

MaxRecordsstring

The requested number of records. The maximum value is 100. Default is 100.

Optionsstring

Options - Specify which options to use for the selected action. List of options in <OptionName>:<Parameter> format. Multiple options are delimited with a ,.

For example: OptionName:Parameter,OptionName:Parameter.

  • IncludeApartments:< On | Off > - This option allows you to include records with a non-null baseMAK. Default of Off will not include non-null baseMAK records.
  • IncludeEmptyLots:< On | Off > - This option allows you to specify if you want to include addresses that are empty lots in your search. Default of Off will not include empty lots.
  • IncludeUndeliverable:< On | Off > - This option allows you to specify if you want to include addresses we have identified as unable to deliver mail to. Default of On will include undeliverable addresses.
TransmissionReferencestring

Serves as a unique request identifier.

Response

Successful response

Versionstring

The current service version number.

TransmissionReferencestring

A pass-through of the input TransmissionReference field.

TransmissionResultsstring

Lists error codes from any errors caused by the most recent request as a whole. For more information, see Reverse GeoCoder Result Codes.

Resultsstring

Comma delimited status, error codes, and change codes for the record. For more information, see Reverse GeoCoder Result Codes.

TotalRecordsinteger

Total number of records.