Reference Guide#

Introduction#

Global Address Verification is a powerful tool that can help you ensure that your mailing addresses are accurate and complete, regardless of where they are in the world.

Global Address Verification can verify, correct, and standardize mailing addresses for over 240 countries and territories. It can also append latitude and longitude coordinates, return address as parsed components, return address in mailing label format according to the standards of each country, and append additional information like unique identifier, delivery indicator, and more depending on the country.

Base URL#

https://address.melissadata.net

Licensing#

The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team at Sales@Melissa.com or 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Global Email will not function.

To set the license key, use the id/CustomerID property in your requests.

Endpoints#

/V3/WEB/GlobalAddress/doGlobalAddress#

Introduction#

Use this endpoint to use all the address verification abilities of Global Address Verification.

Try It Now#

  • GET JSON
  • POST JSON
  • GET XML
  • POST XML
curl -X GET "https://address.melissadata.net/V3/WEB/GlobalAddress/doGlobalAddress?\
&t=Test\
&id={{customerId}}\
&opt=USPreferredCityNames:ON,OutputGeo:ON\
&org=Melissa\
&a1=22382%20Avenida%20Empresa\
&loc=Rancho%20Santa%20Margarita\
&admarea=CA\
&postal=92688\
&ctry=US\
&format=JSON" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
curl -X POST "https://address.melissadata.net/V3/WEB/GlobalAddress/doGlobalAddress" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
      "TransmissionReference": "Test",
      "CustomerID": "{{customerId}}",
      "Options": "USPreferredCityNames:ON,OutputGeo:ON",
      "Records":
      [{
        "RecordID": "1",
        "Organization": "Melissa",
        "AddressLine1": "22382 Avenida Empresa",
        "Locality": "Rancho Santa Margarita",
        "AdministrativeArea": "CA",
        "PostalCode": "92688",
        "Country": "US"
      },
      {
        "RecordID": "2",
        "Organization": "Melissa",
        "AddressLine1": "Caecilienstr. 42-44",
        "Locality": "Cologne",
        "PostalCode": "50667",
        "Country": "Germany"
      }]
    }
   '
curl -X GET "https://address.melissadata.net/V3/WEB/GlobalAddress/doGlobalAddress?\
&t=Test\
&id={{customerId}}\
&opt=USPreferredCityNames:ON,OutputGeo:ON\
&org=Melissa\
&a1=22382%20Avenida%20Empresa\
&loc=Rancho%20Santa%20Margarita\
&admarea=CA\
&postal=92688\
&ctry=US\
&format=XML" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml"
curl -X POST "https://address.melissadata.net/V3/WEB/GlobalAddress/doGlobalAddress" \
-H "Content-Type: application/xml" \
-H "Accept: */*" \
-d '<Request>
      <TransmissionReference>Test</TransmissionReference>
      <CustomerID>{{customerId}}</CustomerID>
      <Options>USPreferredCityNames:ON,OutputGeo:ON</Options>
        <Records>
          <RequestRecord>
            <RecordID>1</RecordID>
            <Organization>Melissa</Organization>
            <AddressLine1>22382 Avenida Empresa</AddressLine1>
            <Locality>Rancho Santa Margarita</Locality>
            <AdministrativeArea>CA</AdministrativeArea>
            <PostalCode>92688</PostalCode>
            <Country>US</Country>
          </RequestRecord>
          <RequestRecord>
            <RecordID>2</RecordID>
            <Organization>Melissa</Organization>
            <AddressLine1>Caecilienstr. 42-44</AddressLine1>
            <Locality>Cologne</Locality>
            <PostalCode>50667</PostalCode>
            <Country>Germany</Country>
          </RequestRecord>
        </Records>
    </Request>
   '
Request Parameters#
  • GET JSON
  • POST JSON
  • GET XML
  • POST XML

Code

Description

t

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

id

Required. The License Key issued by Melissa.

opt

Set Options

CountryOfOrigin

DeliveryLines

DetailedResults

ExtendedDateTime

GBExtras

IncludeRemnant

LineSeparator

OriginDateTime (BETA)

OutputGeo

OutputScript

USExtras

USPreferredCityNames

USStandardizationType

format

Optional. Specify the desired format of the response (XML or JSON).

org

Optional. The organization name associated with the address record.

last

Optional. US Only. For addresses missing a secondary like a suite or apartment, we can use the last name and append that information for residential addresses.

a1

Required. The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

a2

Optional. The input field for the address.

a3

Optional. The input field for the address.

a4

Optional. The input field for the address.

a5

Optional. The input field for the address.

a6

Optional. The input field for the address.

a7

Optional. The input field for the address.

a8

Optional. The input field for the address.

ddeploc

Optional. The smallest population center data element. This depends on the Locality and DependentLocality elements.

deploc

Optional. Urbanization. The smaller population center data element. This depends on the Locality element. In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.

loc

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

subadmarea

Optional. County. The smallest geographic data element.

admarea

Required. State, Province. The most common geographic data element.

postal

Required. ZIP, Postcode. The complete postal code for a particular delivery point. If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.

subnatarea

Optional. The administrative region within a country on an arbitrary level below that of the sovereign state.

ctry

Required. The country name, abbreviation, or code.

Code

Description

TransmissionReference

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

CustomerID

Required. The License Key issued by Melissa.

Options

Set Options

CountryOfOrigin

DeliveryLines

DetailedResults

ExtendedDateTime

GBExtras

IncludeRemnant

LineSeparator

OriginDateTime (BETA)

OutputGeo

OutputScript

USExtras

USPreferredCityNames

USStandardizationType

Format

Optional. Specify the desired format of the response (XML or JSON).

RecordID

Optional. A unique identifier for the current record. Use this to match the record submitted with the record returned.

Organization

Optional. The organization name associated with the address record.

LastName

Optional. US Only. For addresses missing a secondary like a suite or apartment, we can use the last name and append that information for residential addresses.

AddressLine1

Required. The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

AddressLine2

Optional. The input field for the address.

AddressLine3

Optional. The input field for the address.

AddressLine4

Optional. The input field for the address.

AddressLine5

Optional. The input field for the address.

AddressLine6

Optional. The input field for the address.

AddressLine7

Optional. The input field for the address.

AddressLine8

Optional. The input field for the address.

DoubleDependentLocality

Optional. The smallest population center data element. This depends on the Locality and DependentLocality elements.

DependentLocality

Optional. Urbanization. The smaller population center data element. This depends on the Locality element. In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.

Locality

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

SubAdministrativeArea

Optional. County. The smallest geographic data element.

AdministrativeArea

Required. State, Province. The most common geographic data element.

PostalCode

Required. ZIP, Postcode. The complete postal code for a particular delivery point. If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.

SubNationalArea

Optional. The administrative region within a country on an arbitrary level below that of the sovereign state.

Country

Required. The country name, abbreviation, or code.

Code

Description

t

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

id

Required. The License Key issued by Melissa.

opt

Set Options

CountryOfOrigin

DeliveryLines

DetailedResults

ExtendedDateTime

GBExtras

IncludeRemnant

LineSeparator

OriginDateTime (BETA)

OutputGeo

OutputScript

USExtras

USPreferredCityNames

USStandardizationType

format

Optional. Specify the desired format of the response (XML or JSON).

org

Optional. The organization name associated with the address record.

last

Optional. US Only. For addresses missing a secondary like a suite or apartment, we can use the last name and append that information for residential addresses.

a1

Required. The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

a2

Optional. The input field for the address.

a3

Optional. The input field for the address.

a4

Optional. The input field for the address.

a5

Optional. The input field for the address.

a6

Optional. The input field for the address.

a7

Optional. The input field for the address.

a8

Optional. The input field for the address.

ddeploc

Optional. The smallest population center data element. This depends on the Locality and DependentLocality elements.

deploc

Optional. Urbanization. The smaller population center data element. This depends on the Locality element. In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.

loc

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

subadmarea

Optional. County. The smallest geographic data element.

admarea

Required. State, Province. The most common geographic data element.

postal

Required. ZIP, Postcode. The complete postal code for a particular delivery point. If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.

subnatarea

Optional. The administrative region within a country on an arbitrary level below that of the sovereign state.

ctry

Required. The country name, abbreviation, or code.

Code

Description

TransmissionReference

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

CustomerID

Required. The License Key issued by Melissa.

Options

Set Options

CountryOfOrigin

DeliveryLines

DetailedResults

ExtendedDateTime

GBExtras

IncludeRemnant

LineSeparator

OriginDateTime (BETA)

OutputGeo

OutputScript

USExtras

USPreferredCityNames

USStandardizationType

Format

Optional. Specify the desired format of the response (XML or JSON).

RecordID

Optional. A unique identifier for the current record. Use this to match the record submitted with the record returned.

Organization

Optional. The organization name associated with the address record.

LastName

Optional. US Only. For addresses missing a secondary like a suite or apartment, we can use the last name and append that information for residential addresses.

AddressLine1

Required. The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

AddressLine2

Optional. The input field for the address.

AddressLine3

Optional. The input field for the address.

AddressLine4

Optional. The input field for the address.

AddressLine5

Optional. The input field for the address.

AddressLine6

Optional. The input field for the address.

AddressLine7

Optional. The input field for the address.

AddressLine8

Optional. The input field for the address.

DoubleDependentLocality

Optional. The smallest population center data element. This depends on the Locality and DependentLocality elements.

DependentLocality

Optional. Urbanization. The smaller population center data element. This depends on the Locality element. In terms of US Addresses, this element applies only to Puerto Rican addresses. It is used to break ties when a ZIP Code™ is linked to multiple instances of the same address.

Locality

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

SubAdministrativeArea

Optional. County. The smallest geographic data element.

AdministrativeArea

Required. State, Province. The most common geographic data element.

PostalCode

Required. ZIP, Postcode. The complete postal code for a particular delivery point. If all three elements are provided and the PostalCode is incorrect, it can be corrected from the data on the Locality and AdministrativeArea.

SubNationalArea

Optional. The administrative region within a country on an arbitrary level below that of the sovereign state.

Country

Required. The country name, abbreviation, or code.

Options#

List options in the following format, with multiple options delimited with a ,.

OptionName:Parameter,OptionName:Parameter
CountryOfOrigin#

This is used to determine whether or not to include the country name as the last line in FormattedAddress.

Parameter

Description

[Any valid ISO-3166-1 Alpha-2, ISO-3166-1 Alpha-3, or ISO-3166-1 Numeric code]

  • If blank, invalid, or the same as the destination country, then the destination country is not appended to the end of the formatted address.

  • If valid and different from the destination country, then the destination country is appended to the formatted address.

  • US or US Territory:

    • If CountryOfOrigin and destination country being verified are both US or US Territories then the country will not be appended to FormattedAddress.

    • US Territories will have “United States of America” appended if the CountryOfOrigin is not a US Territory, but the CountryName and ISO codes will be that of the territory.

    • Canada is treated like any other non-US Territory.

DeliveryLines#

This options allows you to specify if the Address Lines 1-8 should contain just the delivery address or the entire address.

Parameter

Description

Off

Default. Address Lines 1-8 return the entire address.

On

Address Lines 1-8 return just the street address and dependent locality. It will not contain locality, administrative area, postal code, etc.

DetailedResults#

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.

Parameter

Description

ON

For US and CA addresses only. This will return more detailed and different result codes that come from our Address Object product.

OFF

Default. No extra result codes will be returned.

ExtendedDateTime#

Additional information related to time zone names and UTC information for both standard and daylight savings will be made available in the Extras section. Please see the Extras section for additional details.

Parameter

Description

ON

Additional time zone and UTC information will be made available in the Extras section.

OFF

Default. No additional output information is provided.

GBExtras#

Allows you to choose to add the UPRN output.

Parameter

Description

ON

Adds the additional output value of UPRN. Please see the Extras section for additional details.

OFF

Default. No additional output information is provided.

IncludeRemnant#

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.

This is on by default because it is common to add additional delivery information like Care Of or Attention data, that may be useful and we do not want to throw away. The downside is that this information may not always be useful information, but that is not something we can always determine so we lean on the side of caution.

Parameter

Description

ON

Default. Remnant (extra information) will be appended it to the beginning of the address lines.

OFF

Remnant information will not be appended anywhere in the address lines.

LineSeparator#

This is the line separator used for the FormattedAddress result.

Parameter

Description

SEMICOLON

Default. A semicolon (;).

PIPE

A pipe (|).

CR

A carriage return.

LF

A line feed.

CRLF

A carriage return + line feed.

TAB

A tab.

BR

A line break.

OriginDateTime (BETA)#

A string DateTime value with UTC data to use in the calculation of the local date time.

This feature will allow you to convert the origin time into the local time at the output address. This calculation takes into account the different in UTC from the origin to the output address and also takes into account the dates that daylight savings is observed at the destination.

For example: OriginDateTime:2022-01-13 18:33:16 (UTC-8:00). Note, we need the UTC value to know exactly where the origin time is from. If you do not specify a UTC value, we will assume UTC value of 0.

Parameter

Description

[String]

String DateTime value with UTC data to use in the calculation of the local date time.

OutputGeo#

Allows you to specify if you want geocoding output in the response.

Parameter

Description

ON

Default. Latitude and longitude is returned in the output when available.

OFF

Do not return latitude and longitude for the record.

OutputScript#

This is the script type used for all applicable fields.

Parameter

Description

NOCHANGE

Default. Returns the same script that is sent in.

LATN

Returns in the Latin script.

NATIVE

Returns in the native script for the designated country.

USExtras#

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. Please see the Extras section for additional details.

Parameter

Description

ON

Additional US only output will be made available in the Extras section.

OFF

Default. No additional output information is provided.

USPreferredCityNames#

Allows you to override the city name and return only the USPS preferred city name.

Parameter

Description

ON

If set to on, we will override and return only the USPS preferred city name.

OFF

Default. Leave valid vanity city names as preferred by the USPS.

USStandardizationType#

Allows you to specify the standardization of the address abbreviation.

Parameter

Description

Auto

This uses the input as a guide for how to standardize.

Short

Default. Leave the US address in short abbreviated form as preferred by the USPS. For example:

100 W Main St East

Long

Always spell the address out. For example: 100 West Main Street East

Headers#

  • GET JSON
  • POST JSON
  • GET XML
  • POST XML
Content-Type: application/json
Accept: application/json
Content-Type: application/json
Accept: application/json
Content-Type: application/xml
Accept: */*
Content-Type: application/xml
Accept: */*

Response#

  • GET JSON
  • POST JSON
  • GET XML
  • POST XML
{
  "Version": "3.0.1.174",
  "TransmissionReference": "Test",
  "TransmissionResults": "",
  "TotalRecords": "1",
  "Records": [
    {
      "RecordID": "1",
      "Results": "AC16,AV24,GS05",
      "FormattedAddress": "Melissa;22382 Avenida Empresa;Rancho Santa Margarita, CA 92688-2112",
      "Organization": "Melissa",
      "AddressLine1": "22382 Avenida Empresa",
      "AddressLine2": "Rancho Santa Margarita, CA 92688-2112",
      "AddressLine3": "",
      "AddressLine4": "",
      "AddressLine5": "",
      "AddressLine6": "",
      "AddressLine7": "",
      "AddressLine8": "",
      "SubPremises": "",
      "DoubleDependentLocality": "",
      "DependentLocality": "",
      "Locality": "Rancho Santa Margarita",
      "SubAdministrativeArea": "Orange",
      "AdministrativeArea": "CA",
      "PostalCode": "92688-2112",
      "PostalCodeType": " ",
      "AddressType": "S",
      "AddressKey": "92688211282",
      "SubNationalArea": "",
      "CountryName": "United States of America",
      "CountryISO3166_1_Alpha2": "US",
      "CountryISO3166_1_Alpha3": "USA",
      "CountryISO3166_1_Numeric": "840",
      "CountrySubdivisionCode": "US-CA",
      "Thoroughfare": "Avenida Empresa",
      "ThoroughfarePreDirection": "",
      "ThoroughfareLeadingType": "",
      "ThoroughfareName": "Avenida Empresa",
      "ThoroughfareTrailingType": "",
      "ThoroughfarePostDirection": "",
      "DependentThoroughfare": "",
      "DependentThoroughfarePreDirection": "",
      "DependentThoroughfareLeadingType": "",
      "DependentThoroughfareName": "",
      "DependentThoroughfareTrailingType": "",
      "DependentThoroughfarePostDirection": "",
      "Building": "",
      "PremisesType": "",
      "PremisesNumber": "22382",
      "SubPremisesType": "",
      "SubPremisesNumber": "",
      "PostBox": "",
      "Latitude": "33.637562",
      "Longitude": "-117.606887",
      "DeliveryIndicator": "B",
      "MelissaAddressKey": "8008006245",
      "MelissaAddressKeyBase": "",
      "PostOfficeLocation": "",
      "SubPremiseLevel": "",
      "SubPremiseLevelType": "",
      "SubPremiseLevelNumber": "",
      "SubBuilding": "",
      "SubBuildingType": "",
      "SubBuildingNumber": "",
      "UTC": "UTC-08:00",
      "DST": "Y",
      "DeliveryPointSuffix": "",
      "CensusKey": "060590320531002",
      "Extras": {}
    }
  ]
}
{
  "Version": "3.0.1.174",
  "TransmissionReference": "Test",
  "TransmissionResults": "",
  "TotalRecords": "2",
  "Records": [
    {
      "RecordID": "1",
      "Results": "AC16,AV24,GS05",
      "FormattedAddress": "Melissa;22382 Avenida Empresa;Rancho Santa Margarita, CA 92688-2112",
      "Organization": "Melissa",
      "AddressLine1": "22382 Avenida Empresa",
      "AddressLine2": "Rancho Santa Margarita, CA 92688-2112",
      "AddressLine3": "",
      "AddressLine4": "",
      "AddressLine5": "",
      "AddressLine6": "",
      "AddressLine7": "",
      "AddressLine8": "",
      "SubPremises": "",
      "DoubleDependentLocality": "",
      "DependentLocality": "",
      "Locality": "Rancho Santa Margarita",
      "SubAdministrativeArea": "Orange",
      "AdministrativeArea": "CA",
      "PostalCode": "92688-2112",
      "PostalCodeType": " ",
      "AddressType": "S",
      "AddressKey": "92688211282",
      "SubNationalArea": "",
      "CountryName": "United States of America",
      "CountryISO3166_1_Alpha2": "US",
      "CountryISO3166_1_Alpha3": "USA",
      "CountryISO3166_1_Numeric": "840",
      "CountrySubdivisionCode": "US-CA",
      "Thoroughfare": "Avenida Empresa",
      "ThoroughfarePreDirection": "",
      "ThoroughfareLeadingType": "",
      "ThoroughfareName": "Avenida Empresa",
      "ThoroughfareTrailingType": "",
      "ThoroughfarePostDirection": "",
      "DependentThoroughfare": "",
      "DependentThoroughfarePreDirection": "",
      "DependentThoroughfareLeadingType": "",
      "DependentThoroughfareName": "",
      "DependentThoroughfareTrailingType": "",
      "DependentThoroughfarePostDirection": "",
      "Building": "",
      "PremisesType": "",
      "PremisesNumber": "22382",
      "SubPremisesType": "",
      "SubPremisesNumber": "",
      "PostBox": "",
      "Latitude": "33.637562",
      "Longitude": "-117.606887",
      "DeliveryIndicator": "B",
      "MelissaAddressKey": "8008006245",
      "MelissaAddressKeyBase": "",
      "PostOfficeLocation": "",
      "SubPremiseLevel": "",
      "SubPremiseLevelType": "",
      "SubPremiseLevelNumber": "",
      "SubBuilding": "",
      "SubBuildingType": "",
      "SubBuildingNumber": "",
      "UTC": "UTC-08:00",
      "DST": "Y",
      "DeliveryPointSuffix": "",
      "CensusKey": "060590320531002",
      "Extras": {}
    },
    {
      "RecordID": "2",
      "Results": "AC02,AC16,AC17,AV24,GS05",
      "FormattedAddress": "Melissa;Cäcilienstr. 42-44;50667 Köln;GERMANY",
      "Organization": "Melissa",
      "AddressLine1": "Cäcilienstr. 42-44",
      "AddressLine2": "50667 Köln",
      "AddressLine3": "",
      "AddressLine4": "",
      "AddressLine5": "",
      "AddressLine6": "",
      "AddressLine7": "",
      "AddressLine8": "",
      "SubPremises": "",
      "DoubleDependentLocality": "",
      "DependentLocality": "",
      "Locality": "Köln",
      "SubAdministrativeArea": "Köln",
      "AdministrativeArea": "Köln",
      "PostalCode": "50667",
      "PostalCodeType": "",
      "AddressType": "",
      "AddressKey": "",
      "SubNationalArea": "Nordrhein-Westfalen",
      "CountryName": "Germany",
      "CountryISO3166_1_Alpha2": "DE",
      "CountryISO3166_1_Alpha3": "DEU",
      "CountryISO3166_1_Numeric": "276",
      "CountrySubdivisionCode": "DE-NW",
      "Thoroughfare": "Cäcilienstr.",
      "ThoroughfarePreDirection": "",
      "ThoroughfareLeadingType": "",
      "ThoroughfareName": "Cäcilien",
      "ThoroughfareTrailingType": "Str.",
      "ThoroughfarePostDirection": "",
      "DependentThoroughfare": "",
      "DependentThoroughfarePreDirection": "",
      "DependentThoroughfareLeadingType": "",
      "DependentThoroughfareName": "",
      "DependentThoroughfareTrailingType": "",
      "DependentThoroughfarePostDirection": "",
      "Building": "",
      "PremisesType": "",
      "PremisesNumber": "42-44",
      "SubPremisesType": "",
      "SubPremisesNumber": "",
      "PostBox": "",
      "Latitude": "50.935460",
      "Longitude": "6.951630",
      "DeliveryIndicator": "U",
      "MelissaAddressKey": "6336517595",
      "MelissaAddressKeyBase": "",
      "PostOfficeLocation": "",
      "SubPremiseLevel": "",
      "SubPremiseLevelType": "",
      "SubPremiseLevelNumber": "",
      "SubBuilding": "",
      "SubBuildingType": "",
      "SubBuildingNumber": "",
      "UTC": "UTC+01:00",
      "DST": "Y",
      "DeliveryPointSuffix": "",
      "CensusKey": "",
      "Extras": {}
    }
  ]
}
<Response
  xmlns="urn:mdGlobalAddress"
  xmlns:i="https://www.w3.org/2001/XMLSchema-instance">
  <Version>3.0.1.174</Version>
  <TransmissionReference>Test</TransmissionReference>
  <TransmissionResults/>
  <TotalRecords>1</TotalRecords>
  <Records>
    <ResponseRecord>
      <RecordID>1</RecordID>
      <Results>AC16,AV24,GS05</Results>
      <FormattedAddress>Melissa;22382 Avenida Empresa;Rancho Santa Margarita, CA 92688-2112</FormattedAddress>
      <Organization>Melissa</Organization>
      <AddressLine1>22382 Avenida Empresa</AddressLine1>
      <AddressLine2>Rancho Santa Margarita, CA 92688-2112</AddressLine2>
      <AddressLine3/>
      <AddressLine4/>
      <AddressLine5/>
      <AddressLine6/>
      <AddressLine7/>
      <AddressLine8/>
      <SubPremises/>
      <DoubleDependentLocality/>
      <DependentLocality/>
      <Locality>Rancho Santa Margarita</Locality>
      <SubAdministrativeArea>Orange</SubAdministrativeArea>
      <AdministrativeArea>CA</AdministrativeArea>
      <PostalCode>92688-2112</PostalCode>
      <PostalCodeType></PostalCodeType>
      <AddressType>S</AddressType>
      <AddressKey>92688211282</AddressKey>
      <SubNationalArea/>
      <CountryName>United States of America</CountryName>
      <CountryISO3166_1_Alpha2>US</CountryISO3166_1_Alpha2>
      <CountryISO3166_1_Alpha3>USA</CountryISO3166_1_Alpha3>
      <CountryISO3166_1_Numeric>840</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
      <Thoroughfare>Avenida Empresa</Thoroughfare>
      <ThoroughfarePreDirection/>
      <ThoroughfareLeadingType/>
      <ThoroughfareName>Avenida Empresa</ThoroughfareName>
      <ThoroughfareTrailingType/>
      <ThoroughfarePostDirection/>
      <DependentThoroughfare/>
      <DependentThoroughfarePreDirection/>
      <DependentThoroughfareLeadingType/>
      <DependentThoroughfareName/>
      <DependentThoroughfareTrailingType/>
      <DependentThoroughfarePostDirection/>
      <Building/>
      <PremisesType/>
      <PremisesNumber>22382</PremisesNumber>
      <SubPremisesType/>
      <SubPremisesNumber/>
      <PostBox/>
      <Latitude>33.637562</Latitude>
      <Longitude>-117.606887</Longitude>
      <DeliveryIndicator>B</DeliveryIndicator>
      <MelissaAddressKey>8008006245</MelissaAddressKey>
      <MelissaAddressKeyBase/>
      <PostOfficeLocation/>
      <SubPremiseLevel/>
      <SubPremiseLevelType/>
      <SubPremiseLevelNumber/>
      <SubBuilding/>
      <SubBuildingType/>
      <SubBuildingNumber/>
      <UTC>UTC-08:00</UTC>
      <DST>Y</DST>
      <DeliveryPointSuffix/>
      <CensusKey>060590320531002</CensusKey>
      <Extras/>
    </ResponseRecord>
  </Records>
</Response>
<Response
  xmlns="urn:mdGlobalAddress"
  xmlns:i="https://www.w3.org/2001/XMLSchema-instance">
  <Version>3.0.1.174</Version>
  <TransmissionReference>Test</TransmissionReference>
  <TransmissionResults/>
  <TotalRecords>2</TotalRecords>
  <Records>
    <ResponseRecord>
      <RecordID>1</RecordID>
      <Results>AC16,AV24,GS05</Results>
      <FormattedAddress>Melissa;22382 Avenida Empresa;Rancho Santa Margarita, CA 92688-2112</FormattedAddress>
      <Organization>Melissa</Organization>
      <AddressLine1>22382 Avenida Empresa</AddressLine1>
      <AddressLine2>Rancho Santa Margarita, CA 92688-2112</AddressLine2>
      <AddressLine3/>
      <AddressLine4/>
      <AddressLine5/>
      <AddressLine6/>
      <AddressLine7/>
      <AddressLine8/>
      <SubPremises/>
      <DoubleDependentLocality/>
      <DependentLocality/>
      <Locality>Rancho Santa Margarita</Locality>
      <SubAdministrativeArea>Orange</SubAdministrativeArea>
      <AdministrativeArea>CA</AdministrativeArea>
      <PostalCode>92688-2112</PostalCode>
      <PostalCodeType></PostalCodeType>
      <AddressType>S</AddressType>
      <AddressKey>92688211282</AddressKey>
      <SubNationalArea/>
      <CountryName>United States of America</CountryName>
      <CountryISO3166_1_Alpha2>US</CountryISO3166_1_Alpha2>
      <CountryISO3166_1_Alpha3>USA</CountryISO3166_1_Alpha3>
      <CountryISO3166_1_Numeric>840</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>US-CA</CountrySubdivisionCode>
      <Thoroughfare>Avenida Empresa</Thoroughfare>
      <ThoroughfarePreDirection/>
      <ThoroughfareLeadingType/>
      <ThoroughfareName>Avenida Empresa</ThoroughfareName>
      <ThoroughfareTrailingType/>
      <ThoroughfarePostDirection/>
      <DependentThoroughfare/>
      <DependentThoroughfarePreDirection/>
      <DependentThoroughfareLeadingType/>
      <DependentThoroughfareName/>
      <DependentThoroughfareTrailingType/>
      <DependentThoroughfarePostDirection/>
      <Building/>
      <PremisesType/>
      <PremisesNumber>22382</PremisesNumber>
      <SubPremisesType/>
      <SubPremisesNumber/>
      <PostBox/>
      <Latitude>33.637562</Latitude>
      <Longitude>-117.606887</Longitude>
      <DeliveryIndicator>B</DeliveryIndicator>
      <MelissaAddressKey>8008006245</MelissaAddressKey>
      <MelissaAddressKeyBase/>
      <PostOfficeLocation/>
      <SubPremiseLevel/>
      <SubPremiseLevelType/>
      <SubPremiseLevelNumber/>
      <SubBuilding/>
      <SubBuildingType/>
      <SubBuildingNumber/>
      <UTC>UTC-08:00</UTC>
      <DST>Y</DST>
      <DeliveryPointSuffix/>
      <CensusKey>060590320531002</CensusKey>
      <Extras/>
    </ResponseRecord>
    <ResponseRecord>
      <RecordID>2</RecordID>
      <Results>AC02,AC16,AC17,AV24,GS05</Results>
      <FormattedAddress>Melissa;Cäcilienstr. 42-44;50667 Köln;GERMANY</FormattedAddress>
      <Organization>Melissa</Organization>
      <AddressLine1>Cäcilienstr. 42-44</AddressLine1>
      <AddressLine2>50667 Köln</AddressLine2>
      <AddressLine3/>
      <AddressLine4/>
      <AddressLine5/>
      <AddressLine6/>
      <AddressLine7/>
      <AddressLine8/>
      <SubPremises/>
      <DoubleDependentLocality/>
      <DependentLocality/>
      <Locality>Köln</Locality>
      <SubAdministrativeArea>Köln</SubAdministrativeArea>
      <AdministrativeArea>Köln</AdministrativeArea>
      <PostalCode>50667</PostalCode>
      <PostalCodeType/>
      <AddressType/>
      <AddressKey/>
      <SubNationalArea>Nordrhein-Westfalen</SubNationalArea>
      <CountryName>Germany</CountryName>
      <CountryISO3166_1_Alpha2>DE</CountryISO3166_1_Alpha2>
      <CountryISO3166_1_Alpha3>DEU</CountryISO3166_1_Alpha3>
      <CountryISO3166_1_Numeric>276</CountryISO3166_1_Numeric>
      <CountrySubdivisionCode>DE-NW</CountrySubdivisionCode>
      <Thoroughfare>Cäcilienstr.</Thoroughfare>
      <ThoroughfarePreDirection/>
      <ThoroughfareLeadingType/>
      <ThoroughfareName>Cäcilien</ThoroughfareName>
      <ThoroughfareTrailingType>Str.</ThoroughfareTrailingType>
      <ThoroughfarePostDirection/>
      <DependentThoroughfare/>
      <DependentThoroughfarePreDirection/>
      <DependentThoroughfareLeadingType/>
      <DependentThoroughfareName/>
      <DependentThoroughfareTrailingType/>
      <DependentThoroughfarePostDirection/>
      <Building/>
      <PremisesType/>
      <PremisesNumber>42-44</PremisesNumber>
      <SubPremisesType/>
      <SubPremisesNumber/>
      <PostBox/>
      <Latitude>50.935460</Latitude>
      <Longitude>6.951630</Longitude>
      <DeliveryIndicator>U</DeliveryIndicator>
      <MelissaAddressKey>6336517595</MelissaAddressKey>
      <MelissaAddressKeyBase/>
      <PostOfficeLocation/>
      <SubPremiseLevel/>
      <SubPremiseLevelType/>
      <SubPremiseLevelNumber/>
      <SubBuilding/>
      <SubBuildingType/>
      <SubBuildingNumber/>
      <UTC>UTC+01:00</UTC>
      <DST>Y</DST>
      <DeliveryPointSuffix/>
      <CensusKey/>
      <Extras/>
    </ResponseRecord>
  </Records>
</Response>
Service Level Response Fields#

Output Name

Description

Version

The current service version number.

TransmissionReference

Optional. Serves as a unique request identifier.

TransmissionResults

Lists error codes from any errors caused by the most recent request as a whole.

TotalRecords

Total number of records.

Record Level Response Fields#

Output Name

Description

RecordID

The number of the record. Always 1 for a single email request, otherwise it serves as an index of the array of records.

Results

Comma delimited status, error codes, and change codes for the record.

FormattedAddress

The address in the correct format for mailing from the country specified in the CountryOfOrigin element. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required).

Separate lines will be delimited by what is specified in the LineSeparator option.

Organization

Business, Company. String value that matches the Organization request element. It is not modified or populated by the service.

AddressLine1

These are the string values that will return the standardized or corrected contents of the input address.

These lines will include the entire address including the locality, administrative area, and postal code. If the DeliveryLines option is turned on, only the address up to the dependent locality will be returned.

AddressLine2

Standardized or corrected contents of the input address line 2.

AddressLine3

Standardized or corrected contents of the input address line 3.

AddressLine4

Standardized or corrected contents of the input address line 4.

AddressLine5

Standardized or corrected contents of the input address line 5.

AddressLine6

Standardized or corrected contents of the input address line 6.

AddressLine7

Standardized or corrected contents of the input address line 7.

AddressLine8

Standardized or corrected contents of the input address line 8.

SubPremises

Suite, Apartment. The parsed SubPremises from the AddressLine elements. A subpremise are individual units with their own addresses inside a building.

DoubleDependentLocality

The standardized contents of the DoubleDependentLocality element.

A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used. Great Britain is an example of a country that uses double dependent locality.

DependentLocality

Urbanization. The standardized contents of the DependentLocality element. A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector.

Great Britain is an example of a country that uses double dependent locality. In the United States, this would correspond to Urbanization, which is used only in Puerto Rico.

Locality

City. The standardized contents of the Locality element. This is the most common geographic area and used by virtually all countries.

This is usually the value that is written on a mailing label and referred to by terms like City, Town, or Postal Town.

SubAdministrativeArea

County. The standardized contents of the SubAdministrativeArea element. This is a logical area that that is smaller than the administrative area but larger than a locality.

While many countries can have a sub-administrative area value, it is very rarely used as part of an official address.

AdministrativeArea

State, Province. The standardized contents of the AdministrativeArea element. This is a common geographic area unit for larger countries.

PostalCode

ZIP Code. The standardized contents of the PostalCode element. Most countries have some form of a postal code system.

PostalCodeType

This is a country dependent field. This field returns an identifier that represents the type of postal code returned. Currently only the US uses this field.

For a list of these codes, see the Product Codes list.

Appended Address Record Elements#

Output Name

Description

AddressType

A one-character code for the type of address coded.

See the Product Codes for a list of Address Type Codes.

AddressKey

This is a country dependent field:

  • US: This returns a 11 digit code representing the combination of the zip code, the plus4, and the delivery point. This is a fairly good representation of a unique US address and often used as the core of postal barcode. However, this code is not guaranteed to be unique to an individual address, please use the MelissaAddressKey instead for that purpose. It is possible that this field is empty or not 11 digits if the address is a Non-USPS address (link to something about non-usps addresses).

  • GB: This field returns the UDPRN, which stands for Unique Delivery Point Reference Number. It is an 8 character code that is assigned and maintained by Royal Mail to each delivery point address.

  • AU: This returns the DPID (Delivery Point ID). This is a 8 digit number that identifies a mailbox according to Australia Post.

The AddressKey can be used by other Melissa Data services, such as Geocoder or RBDI.

SubNationalArea

The standardized arbitrary administrative region below that of the sovereign state.

A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.

CountryName

The standardized contents of the CountryName element.

CountryISO3166_1_Alpha2

The 2 letter ISO 3166 country code value.

For example: US for United States or CA for Canada.

CountryISO3166_1_Alpha3

The 3 letter ISO 3166 country code value.

For example: USA for United States or CAN for Canada.

CountryISO3166_1_Numeric

The ISO 3166 country number value.

For example: 840 for United States or 124 for Canada.

CountrySubdivisionCode

The ISO3166-2 code for country subdivisions, usually tied to the administrative area for a country.

The format is the 2 letter country code followed by a dash followed by 2 or 3 characters or two numbers.

For example: US-CA, CN-16, or AU-VIC.

This field is only populated for the following countries: AE, AR, AT, AU, BB, BE, BH, BR,BS, CA, CH, CL, CN, CO, CR, DE, DK, DM, DO, ES, FI, FJ, FR, GB, GH, GT, GY, HN, ID, IE, IL, IN, IS, IT, JP, KR, KW, LT, LU, LV, MX, MY, NC, NG, NI, NL, NO, NZ, PE, PH, PK, PL, PR, PT, RS, SA, SG, SI, SV, TH, TR, UA, US, UY, VN.

Thoroughfare

Street. The most common street or block data element.

This value is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.

ThoroughfarePreDirection

Street PreDirection. The parsed prefix directional within the Thoroughfare field.

ThoroughfareLeadingType

The parsed leading thoroughfare type indicator within the Thoroughfare field.

A leading type is a thoroughfare type that is placed before the thoroughfare.

For example, the thoroughfare type of Rue in Canada and France is placed before the thoroughfare, making it a leading type.

ThoroughfareName

Street Name. The parsed name indicator within the Thoroughfare field.

ThoroughfareTrailingType

Street Suffix. The parsed trailing thoroughfare type indicator within the Thoroughfare field.

A trailing type is a thoroughfare type that is placed after the thoroughfare.

For example, the thoroughfare type of Avenue in the US is placed after the thoroughfare, making it a trailing type.

ThoroughfarePostDirection

Post Direction. The parsed postfix directional within the Thoroughfare field.

DependentThoroughfare

Dependent Street. The parsed block data element.

The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used.

DependentThoroughfarePreDirection

The parsed prefix directional within the DependentThoroughfare field.

DependentThoroughfareLeadingType

The parsed leading thoroughfare type indicator within the DependentThoroughfare field.

DependentThoroughfareName

The parsed name indicator within the DependentThoroughfare field.

DependentThoroughfareTrailingType

The parsed trailing thoroughfare type indicator within the DependentThoroughfare field.

DependentThoroughfarePostDirection

The parsed postfix directional indicator within the DependentThoroughfare field.

Building

The parsed descriptive name identifying an individual location.

PremisesType

The parsed leading premise type indicator within the premises field.

PremisesNumber

House Number. The parsed alphanumeric indicator within the premises field.

SubPremisesType

Suite Name. The parsed sub premises type indicator within the premises field.

SubPremisesNumber

Suite Number. The parsed sub premises number indicator within the premises field.

PostBox

The parsed post box information for a particular delivery point.

Latitude

The parsed geographic coordinate for a particular delivery point.

Longitude

The parsed geographic coordinate for a particular delivery point.

DeliveryIndicator

A one character code that indicates if the address is a residence (R), business (B), or unknown (U).

It is not available for all countries. Currently, this field is available for the US, GB, NL and IE with more countries planned in the future.

See Product Codes for a list of these codes.

MelissaAddressKey

This is a globally unique and persistent key for the postal address, even if parts of the address change.

When an address is fully validated this field returns a 10-digit proprietary unique identifier for that address. With AddressKey (US and Canada only), if an address zip code changes, the AddressKey would also change. Melissa Address Key (MAK) is independent and will not change. This makes MAK a good way to permanently identify and also to use as a value for finding duplicates. Currently, we return MAK numbers for over 50 countries with more planned for the future.

MelissaAddressKeyBase

Every full address has its own Melissa Address Key (MAK).

If that address is a suites or apartment, we will also return a Melissa Address Key Base (BaseMAK) that corresponds to the overall building. This provides a link between all the individual MAK addresses that belong to the same building. This field also returns a 10-digit proprietary key.

Note, if we can validate the address to the building but not the suite, we can return just the BaseMAK. Currently available for countries that have support for MelissaAddressKey.

PostOfficeLocation

The location of the post office in relation to the record address, if available. This may or may not be used in the official mailing address for the country in question.

Currently, these are the countries we will return the data for: Serbia and Slovakia.

SubPremiseLevel

A secondary piece of sub premise information used to describe a more generic division of the subpremise.

For example, if you have an address like 1123 Market Way, Floor 12 Apt 25A then the Subpremises will be Apt 25A and the SubPremiseLevel will be Floor 12. This value is not widely used in official address data.

SubPremiseLevelType and SubPremiseLevelNumber make up the SubPremiseLevel.

SubPremiseLevelType

Floor. Part of the SubPremiseLevel.

SubPremiseLevelNumber

Floor Number. Part of the SubPremiseLevel.

SubBuilding

A smaller division of the building.

For example, if an address has a building name that is a part of a larger set of buildings, then the sub building may be populated.

SubBuildingType and SubBuildingNumber make up the parts of SubBuilding.

SubBuildingType

This is part of the SubBuilding.

SubBuildingNumber

This is part of the SubBuilding.

UTC

The Coordinated Universal Time number in format of UTC+#.

Note that there are timezones that are not whole hours only, like UTC+9:30.

DST

Y or N, based on if the country or area of the input observes daylight savings time.

Note that the value returned by the UTC output does not change based on whether the country/area is currently in daylight savings time for not. We will only return the standard timezone and this flag to indicate is daylight savings is observed.

DeliveryPointSuffix

This is a country dependent field. This field returns an identifier that represents a suffix code usually tied to a delivery point.

GB: This is a 2 character (first is numerical, 2nd character is alphabetic) that is assigned by Royal Mail. When added to the postal code, this allows each live delivery point to be uniquely identified.

CensusKey

This is a country dependent field. It is designed to return a code that correspond to the census division information for a country. Currently, this field is only returned for the US.

US: The CensusKey for the US is a 15 or 16 digit code that is made up of the following components: FIPS Code, Census Tract, Census Block, and CensusBlockGroup if it exists.

Extras#

The Extras section is a place where we will put less used output fields our more granular country specific output fields. This section is structured differently so that we have the flexibility to expand them in the future. These outputs structured as key/value pairs and the output values present in this section will depend on the options you have selected. The output format for this will look like this example below:

<Extras>
    <root>
        <extra>
            <key>CBSACode</key>
            <value>31080</value>
        </extra>
        <extra>
            <key>CBSADivisionCode</key>
            <value>11244</value>
        </extra>
        <extra>
            <key>CBSADivisionLevel</key>
            <value>Metropolitan Statistical Area</value>
        </extra>
    </root>
</Extras>

Here are the possible output and groups:

Output Name

Activating Option

Description

DaylightSavingsTimezone

ExtendedDateTime

Worldwide. The Daylight Savings Time Zone Name for the output address.

DaylightSavingsUTC

ExtendedDateTime

Worldwide. The UTC value for the output address when they are observing Daylight savings.

LocalDateTime

ExtendedDateTime

[BETA] - Worldwide. The local date time value calculated from the OriginDateTime input taking into account the whether the output address area observes daylight savings and the time period when it observes daylight savings. Note that OriginaDateTime is specified as an option rather than a regular input value.

StandardTimezone

ExtendedDateTime

Worldwide. The Standard Time Zone Name for the output address.

UPRN

GBExtras

GB Only. Returns the Unique Property Reference Number created and maintained by Ordnance Survey.

CarrierRoute

USExtras

US Only. Carrier Route Code assigned by the USPS.

CBSA Outputs

USExtras

US Only. Core-Based Statistical Areas (CBSA) outputs. These values are assigned by the US Census.

  • CBSACode

  • CBSADivisionCode

  • CBSADivisionLevel

  • CBSADivisionTitle

  • CBSALevel

  • CBSATitle

CensusBlock

USExtras

US Only. The Census block number from the most recent yearly census.

CensusTract

USExtras

US Only. The Census tract number from the most recent yearly census.

CongressionalDistrict

USExtras

US Only. The congressional district number for the address.

CountyFIPS

USExtras

US Only. The Census FIPS number from the most recent yearly census.

CountyName

USExtras

US Only. The county name that corresponds to the county FIPS code.

CountySubdivisionCode

USExtras

US Only. The county subdivision code value as defined by the US Census.

CountySubdivisionName

USExtras

US Only. The county subdivision name value as defined by the US Census.

DeliveryPointCheckDigit

USExtras

US Only. The single digit value that acts as a checksum to the delivery point code.

DeliveryPointCode

USExtras

US Only. The 2 digit delivery point code as assigned by the USPS.

ElementarySchoolDistrictCode

USExtras

US Only. Returns a 5 digit string representing the elementary school district code for the address.

ElementarySchoolDistrictName

USExtras

US Only. Returns a 5 digit string representing the elementary school district code for the address.

PlaceCode

USExtras

US Only. The FIPS Place code as defined by the Census.

PlaceName

USExtras

US Only. The FIPS Place name as defined by the Census.

SecondarySchoolDistrictCode

USExtras

US Only. The secondary school district code for the address.

SecondarySchoolDistrictName

USExtras

US Only. The secondary school district name for the address.

StateDistrictLower

USExtras

US Only. Returns a 3 digit string representing the Lower State District Code for the requested record.

StateDistrictUpper

USExtras

US Only. Returns a 3 digit string representing the Upper State District Code for the requested record.

UnifiedSchoolDistrictCode

USExtras

US Only. Returns a 5 digit string representing the Unified School District Code if the address is in a unified school district.

UnifiedSchoolDistrictNameString

USExtras

US Only. Returns a 5 digit string representing the Unified School District Name if the address is in a unified school district.

Result Codes#

Result codes yield more granular information about a given record. They are returned as a comma-delimited string of 4-character alpha-numeric codes, e.g. AC02,AS01 or AE01.

SE## and GE## Codes#

The SE## and GE## codes (Transmission Service Error and General Transmission Error) are used to signify more general errors, and are returned under the key TransmissionResults in the outermost level of our responses.

Service Level Result Codes#

Code

Short Description

Long Description

Transmission Service Error

SE01

Cloud Service Internal Error

The cloud service experienced an internal error.

General Transmission Error

GE02

Empty Request Record Structure

The SOAP, JSON, or XML request record structure is empty. Not to be confused with the GE02 GeoCode result code.

GE03

Records Per Request Exceeded

The counted records sent more than the number of records allowed per request.

GE04

Empty License Key

The License Key is empty.

GE05

Invalid License Key

The License Key is invalid.

GE06

Disabled License Key

The License Key is disabled.

GE08

Product/Level Not Enabled

The License Key is invalid for this product or level.

GE09

Customer Does Not Exist

The Customer ID is not in our system.

GE10

Customer License Disabled

The encrypted license is on the ban list.

GE11

Customer Disabled

The Customer ID is disabled.

GE12

IP Blacklisted

The IP Address is on the global ban list.

GE13

IP Not Whitelisted

The IP Address is not on the customer’s whitelist.

GE14

Out of Credits

The account has ran out of credits. Add more credits to continue using the service.

General Transmission Warning

GW01

Expiring License

Your License Key is expiring soon. Please contact your sales representative for a new License Key.

Record Level Result Codes#

Code

Short Description

Long Description

AC - Address Change

AC01

Postal Code Change

The postal code was changed or added.

AC02

Administrative Area Change

The administrative area (state, province) was added or changed.

AC03

Locality Change

The locality (city, municipality) name was added or changed.

AC09

Dependent Locality Change

The dependent locality (urbanization) was changed.

AC10

Thoroughfare Name Change

The thoroughfare (street) name was added or changed due to a spelling correction.

AC11

Thoroughfare Type Change

The thoroughfare (street) leading or trailing type was added or changed, such as from “St” to “Rd.”

AC12

Thoroughfare Directional Change

The thoroughfare (street) pre-directional or post-directional was added or changed, such as from “N” to “NW.”

AC13

Sub Premise Type Change

The sub premise (suite) type was added or changed, such as from “STE” to “APT.”

AC14

Sub Premise Number Change

The sub premise (suite) unit number was added or changed.

AC15

Double Dependent Locality Change

The double dependent locality was added or changed.

AC16

SubAdministrative Area Change

The subadministrative area was added or changed.

AC17

SubNational Area Change

The subnational area was added or changed.

AC18

PO Box Change

The PO Box was added or changed.

AC19

Premise Type Change

The premise type was added or changed.

AC20

House Number Change

The house number was changed.

AC22

Organization Change

The organization was added or changed.

AE - Address Error

AE01

General Error

The address could not be verified. This is likely due to a missing or invalid locality or postal code.

AE02

Unknown Street

Could not match the input street to a unique street name. Either no matches or too many matches found.

AE03

Component Mismatch Error

The combination of directionals (N, E, SW, etc) and the suffix (AVE, ST, BLVD) is not correct and produced multiple possible matches.

AE05

Multiple Match

The address was matched to multiple records. There is not enough information available in the address to break the tie between multiple records.

AE08

Sub Premise Number Invalid

The thoroughfare (street address) was found but the sub premise (suite) was not valid.

AE09

Sub Premise Number Missing

The thoroughfare (street address) was found but the sub premise (suite) was missing.

AE10

Premise Number Invalid

The premise (house or building) number for the address is not valid.

AE11

Premise Number Missing

The premise (house or building) number for the address is missing.

AE12

Box Number Invalid

The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is invalid.

AE13

Box Number Missing

The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is missing.

AE14

PMB Number Missing

US Only. The address is a Commercial Mail Receiving Agency (CMRA) and the Private Mail Box (PMB or #) number is missing.

AE17

Sub Premise Not Required (Deprecated - See AS23)

A sub premise (suite) number was entered but the address does not have secondaries. (Deprecated - See AS23)

AS - Address Status

AS09

Foreign Address

The address is in a non-supported country.

AV - Address Verification

AV11

Administrative Area Partial

The address has been partially verified to the Administrative Area (State) Level, which is NOT the highest level possible with the reference data.

AV12

Locality Partial

The address has been partially verified to the Locality (City) Level, which is NOT the highest level possible with the reference data.

AV13

Thoroughfare Partial

The address has been partially verified to the Thoroughfare (Street) Level, which is NOT the highest level possible with the reference data.

AV14

Premise Partial

The address has been partially verified to the Premise (House or Building) Level, which is NOT the highest level possible with the reference data.

AV21

Administrative Area Full

The address has been verified to the Administrative Area (State) Level, which is the highest level possible with the reference data.

AV22

Locality Full

The address has been verified to the Locality (City) Level, which is the highest level possible with the reference data.

AV23

Thoroughfare Full

The address has been verified to the Thoroughfare (Street) Level, which is the highest level possible with the reference data.

AV24

Premises Full

The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data.

AV25

SubPremises Full

The address has been verified to the SubPremise (Suite) or PO Box Level, which is the highest level possible with the reference data.

GEO-GS - GeoCode Status

GS01

Geocoded to Street Level

The record was coded to the street level (Zip+4 for US, full postal code for CA).

GS02

Geocoded to the Neighborhood Level

The record was geocoded down to neighborhood level (Zip+2 for US).

GS03

Geocoded to Community Level

The record was coded to the community level (ZIP centroid for US, 3-digit postal code for CA).

GS04

Geocoded to State Level

The record was geocoded to the state (administrative area) level.

GS05

Geocoded to Rooftop Level

The record was geocoded down to the rooftop level, meaning the point is within the property boundaries, usually the center.

GS06

Geocoded to Interpolated Rooftop Level

The record was geocoded down to the rooftop level using interpolation (educated estimations using street coordinates). The point may be in or close to the property boundaries.

GEO-GE - GeoCode Error

GE01

Regional Geocode Not Found

Geocode could not be appended for the input locality or postal code.

GE02

No Geocode for Input Address

The input address did not provide enough valid information to append a geocode.

Record Level Product Codes#

Code

Description

Address Type US

A

Alias

F

Firm or Company

H

Highrise or Business Complex

G

General Delivery

P

PO Box

R

Rural Route

S

Street or Residential

Address Type Canada

1

Street

2

Street Served by Route and GD

3

Lock Box

4

Route Service

5

General Delivery

B

LVR Street

C

Government Street

D

LVR Lock Box

E

Government Lock Box

L

LVR General Delivery

K

Building

Address Type Austria

T

A door number (Tür) is expected for this address to be considered complete.

Address Type France

C

This address is a CEDEX address. These are addresses classified as “Courier d’entreprise à distribution exceptionnelle” or “special business mail” by La Poste. They are given their own postal priority and usually large organizations.

Address Type Great Britain

L

This address is identified as having a large user postal code. This is due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up.

S

This address is identified as having a smaller user postal code. This means this postal code will have usually around 15 delivery points but never more than 100.

Address Type Switzerland

M

Domicile and specialist addresses

S

Domicile addresses only

T

Specialist postcodes only

F

Company postcodes

P

In-house Swiss Post postcodes (delivery post office information on bundle labels or bag addresses).

Delivery Indicator Code

R

Residence

B

Business

U

Unknown

Postal Code Type

[Empty]

Regular postal code

M

Military Postal Code

P

PO Box Postal Code

U

Unique Postal Code usually assigned to a large organization or government institution.