FormattedAddress

This is a string value that is 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 option. See LineSeparator for more information.

Protocol

Syntax

JSON

"FormattedAddress":"string"

SOAP/XML

<FormattedAddress>string</FormattedAddress>

Organization

This is a string value that matches the Organization request element. It is not modified or populated by the Cloud Service.

Protocol

Syntax

JSON

"Organization":"string"

SOAP/XML

<Organization>string</Organization>

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.

Protocol

Syntax

JSON

"AddressLine1":"string"

SOAP/XML

<AddressLine1>string</AddressLine1>

AddressLine2

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.

Protocol

Syntax

JSON

"AddressLine2":"string"

SOAP/XML

<AddressLine2>string</AddressLine2>

AddressLine3

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.

Protocol

Syntax

JSON

"AddressLine3":"string"

SOAP/XML

<AddressLine3>string</AddressLine3>

AddressLine4

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.

Protocol

Syntax

JSON

"AddressLine4":"string"

SOAP/XML

<AddressLine4>string</AddressLine4>

AddressLine5

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.

Protocol

Syntax

JSON

"AddressLine5":"string"

SOAP/XML

<AddressLine5>string</AddressLine5>

AddressLine6

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.

Protocol

Syntax

JSON

"AddressLine6":"string"

SOAP/XML

<AddressLine6>string</AddressLine6>

AddressLine7

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.

Protocol

Syntax

JSON

"AddressLine7":"string"

SOAP/XML

<AddressLine7>string</AddressLine7>

AddressLine8

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.

Protocol

Syntax

JSON

"AddressLine8":"string"

SOAP/XML

<AddressLine8>string</AddressLine8>

SubPremises

This is a string value that is the parsed SubPremises from the AddressLine elements. A subpremise are individual units with their own addresses inside a building.

US Term: Suite or Apartment

Protocol

Syntax

JSON

"SubPremises":"string"

SOAP/XML

<SubPremises>string</SubPremises>

DoubleDependentLocality

This is a string value that is 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.

Protocol

Syntax

JSON

"DoubleDependentLocality":"string"

SOAP/XML

<DoubleDependentLocality>string</DoubleDependentLocality>

DependentLocality

This is a string value that is 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.

US Term: Urbanization

Protocol

Syntax

JSON

"DependentLocality":"string"

SOAP/XML

<DependentLocality>string</DependentLocality>

Locality

This is a string value that is 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, Postal Town, etc.

US Term: City

Protocol

Syntax

JSON

"Locality":"string"

SOAP/XML

<Locality>string</Locality>

SubAdministrativeArea

This is a string value that is 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.

US Term: County

Protocol

Syntax

JSON

"SubAdministrativeArea":"string"

SOAP/XML

<SubAdministrativeArea>string</SubAdministrativeArea>

AdministrativeArea

This is a string value that is the standardized contents of the AdministrativeArea element. This is a common geographic area unit for larger countries. Often referred to as State or Province.

US Term: State

Protocol

Syntax

JSON

"AdministrativeArea":"string"

SOAP/XML

<AdministrativeArea>string</AdministrativeArea>

PostalCode

This is a string value that is the standardized contents of the PostalCode element. Most countries have some form of a postal code system.

US Term: Zip Code

Protocol

Syntax

JSON

"PostalCode":"string"

SOAP/XML

<PostalCode>string</PostalCode>

Appended Address Record Elements

AddressType

This is an appended string value that returns a one-character code for the type of address coded. This element works only for US and Canadian addresses.

Protocol

Syntax

JSON

"AddressType":"string"

SOAP/XML

<AddressType>string</AddressType>

AddressKey

This is a string value that is a unique key for the address. Only for US and Canadian addresses.

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

Protocol

Syntax

JSON

"AddressKey":"string"

SOAP/XML

<AddressKey>string</AddressKey>

SubNationalArea

This is a string value that is the standardized contents of the SubNationalArea element. 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.

Protocol

Syntax

JSON

"SubNationalArea":"string"

SOAP/XML

<SubNationalArea>string</SubNationalArea>

CountryName

This is a string value that is the standardized contents of the CountryName element.

Protocol

Syntax

JSON

"CountryName":"string"

SOAP/XML

<CountryName>string</CountryName>

CountryISO3166_1_Alpha2

This is a string value that is the 2 letter ISO 3166 country code value.

For example:

Country

Code

United States

US

Canada

CA

Philippines

PH

Protocol

Syntax

JSON

"CountryISO3166_1_Alpha2":"string"

SOAP/XML

<CountryISO3166_1_Alpha2>string</CountryISO3166_1_Alpha2>

CountryISO3166_1_Alpha3

This is a string value that is the 3 letter ISO 3166 country code value.

For example:

Country

Code

United States

USA

Canada

CAN

Philippines

PHL

Protocol

Syntax

JSON

"CountryISO3166_1_Alpha3":"string"

SOAP/XML

<CountryISO3166_1_Alpha3>string</CountryISO3166_1_Alpha3>

CountryISO3166_1_Numeric

This is a string value that is the ISO 3166 country number value.

For example:

Country

Code

United States

840

Canada

124

Philippines

608

Protocol

Syntax

JSON

"CountryISO3166_1_Numeric":"string"

SOAP/XML

<CountryISO3166_1_Numeric>string</CountryISO3166_1_Numeric>

CountrySubdivisionCode

This is 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. Examples are: US-CA, CN-16, or AU-VIC.

Thoroughfare

This is a string value that is the parsed Thoroughfare element from the output. 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.

US Term: Street

Protocol

Syntax

JSON

"Thoroughfare":"string"

SOAP/XML

<Thoroughfare>string</Thoroughfare>

ThoroughfarePreDirection

This is a string value that is the parsed ThoroughfarePreDirection element from the output. This value is a part of the Thoroughfare field.

US Term: Pre Direction

Protocol

Syntax

JSON

"ThoroughfarePreDirection":"string"

SOAP/XML

<ThoroughfarePreDirection>string</ThoroughfarePreDirection>

ThoroughfareLeadingType

This is a string value that is the parsed ThoroughfareLeadingType element from the output. A leading type is a thoroughfare type that is placed before the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Rue" in Canada and France is placed before the thoroughfare, making it a leading type.

US Term: Not used in the US

Protocol

Syntax

JSON

"ThoroughfareLeadingType":"string"

SOAP/XML

<ThoroughfareLeadingType>string</ThoroughfareLeadingType>

ThoroughfareName

This is a string value that is the parsed ThoroughfareName element from the output. This value is a part of the Thoroughfare field.

US Term: Street name

Protocol

Syntax

JSON

"ThoroughfareName":"string"

SOAP/XML

<ThoroughfareName>string</ThoroughfareName>

ThoroughfareTrailingType

This is a string value that is the parsed ThoroughfareTrailingType element from the output. A trailing type is a thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Avenue" in the US is placed after the thoroughfare, making it a trailing type.

US Term: Street Suffix

Protocol

Syntax

JSON

"ThoroughfareTrailingType":"string"

SOAP/XML

<ThoroughfareTrailingType>string</ThoroughfareTrailingType>

ThoroughfarePostDirection

This is a string value that is the parsed ThoroughfarePostDirection element from the output. This value is a part of the Thoroughfare field.

US Term: Post Direction

Protocol

Syntax

JSON

"ThoroughfarePostDirection":"string"

SOAP/XML

<ThoroughfarePostDirection>string</ThoroughfarePostDirection>

DependentThoroughfare

This is a string value that is the parsed DependentThoroughfare element from the output. The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used.

Protocol

Syntax

JSON

"DependentThoroughfare":"string"

SOAP/XML

<DependentThoroughfare>string</DependentThoroughfare>

DependentThoroughfarePreDirection

This is a string value that is the parsed DependentThoroughfarePreDirection element from the output. This value is a part of the DependentThoroughfare field.