Sign in

v1

latestOpenAPI 3.1.22026-08-062492.5 KB
Address Verification

Verify addresses

Use this endpoint to submit a request to verify or standardize multiple global addresses in batch.

post/doGlobalAddress

Headers

Accept'application/json' | '*/*' 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.

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.

  • AreaDetails:< ON | OFF > - This option appends regional classification codes to the Extras section. Default of off has no regional classification codes included in the response.
  • CountryOfOrigin:<ISO2, ISO3, or ISO#> - This is used to determine whether or not to include the country name as the last line in FormattedAddress.
  • DeliveryLines:< ON | OFF > - This options allows you to specify if the Address Lines 1-8 should contain just the delivery address or the entire address. Default of off has Address Lines 1-8 return the entire address.
  • DetailedResults:< ON | OFF > - This is for users that have experience or code using Address Object and would like to have those codes alongside the Global Address result codes. Default of OFF will not return extra result codes.
  • ExtendedDateTime:< ON | OFF > - Additional information related to time zone names and UTC information for both standard and daylight savings will be made available in the Extras section. Default of OFF will not provide additional output information.
  • GBExtras:< ON | OFF > - Allows you to choose to add the UPRN output. Default of OFF will not provide additional output information.
  • IncludeRemnant:< ON | OFF > - In cases where Global Address identifies a piece of the input as extra information, we label this as Remnant and can append it to the beginning of the address lines. Default of ON will append remnant (extra information) to the beginning of the address lines.
  • LineSeparator:< SEMICOLON | PIPE | CR | LF | CRLF | TAB | BR> - This is the line separator used for the FormattedAddress result. Default of SEMICOLON uses a semicolon (;).
  • MelissaCityKeys:< ON | OFF > - When this option is enabled, ID fields representing a unique combination of ZIP Code, City, County, State, and Country will be appended to the Extras section. Currently available for the US. Default of OFF will not provide additional output information.
  • OriginDateTime:< String with UTC data > - (BETA) A string DateTime value with UTC data to use in the calculation of the local date time. For example: OriginDateTime:2022-01-13 18:33:16 (UTC-8:00).
  • OutputGeo:< ON | OFF > - Allows you to specify if you want geocoding output in the response. Default of ON will return latitude and longitude when available.
  • OutputScript:< NOCHANGE | LATN | NATIVE > - This is the script type used for all applicable fields. Default of NOCHANGE will return the same script that is sent in.
  • Suggestion:< ON | OFF > - (BETA) Available only for single-record requests. In cases where Global Address cannot fully verify an address, alternate suggestions may be returned in the Suggestions response field. Default of OFF will not provide alternate address suggestions.
  • USExtras:< ON | OFF > - These are additional US only output will that can be made available in the Extras section. These outputs are related to Census, County, and School information. Default of OFF will not provide additional output information.
  • USPreferredCityNames:< ON | OFF > Allows you to override the city name and return only the USPS preferred city name. Default of OFF will leave valid vanity city names as preferred by the USPS.
  • USStandardizationType:< Auto | Short | Long > Allows you to specify the standardization of the address abbreviation. Default of Short will leave the US address in short abbreviated form as preferred by the USPS.
TransmissionReferencestring

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

Response

Successful response

Versionstring

The current service version number.

TransmissionReferencestring

Serves as a unique request identifier.

TransmissionResultsstring

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

TotalRecordsstring

Total number of records.

Example response

{
  "Records": [
    {
      "Suggestions": [
        {
          "RecordID": "1",
          "FormattedAddress": "22382 Avenida Empresa, Rancho Santa Margarita, CA 92688-2112",
          "AddressLine1": "22382 Avenida Empresa",
          "Locality": "Rancho Santa Margarita",
          "AdministrativeArea": "CA",
          "PostalCode": "92688-2112",
          "CountryName": "United States",
          "CountryISO3166_1_Alpha2": "US",
          "CountryISO3166_1_Alpha3": "USA",
          "CountryISO3166_1_Numeric": "840",
          "CountrySubdivisionCode": "US-CA",
          "Thoroughfare": "Avenida Empresa",
          "Latitude": "33.637562",
          "Longitude": "-117.606887",
          "MelissaAddressKey": "8008006245"
        }
      ]
    }
  ]
}