Global Address Verification:Response

← Global Address Verification

A response is the result of a request. This consists of returned results codes, parsed address elements, and appended address information.

Depending on the protocol used to make the request, the response will be in a certain protocol. Global Address Verification supports the JSON, JSONP, SOAP, and XML protocols.

Field Names

This is a list of the response field names and their protocol naming conventions.

Field Name	Level	JSON/XML
Version	Response	Version
Transmission Reference		TransmissionReference
Transmission Results		TransmissionResults
Total Records		TotalRecords
Record ID	Record	RecordID
Results		Results
Formatted Address		FormattedAddress
Organization		Organization
Address Line 1		AddressLine1
Address Line 2		AddressLine2
Address Line 3		AddressLine3
Address Line 4		AddressLine4
Address Line 5		AddressLine5
Address Line 6		AddressLine6
Address Line 7		AddressLine7
Address Line 8		AddressLine8
Sub Premises		SubPremises
Double Dependent Locality		DoubleDependentLocality
Dependent Locality		DependentLocality
Locality		Locality
Sub Administrative Area		SubAdministrativeArea
Administrative Area		AdministrativeArea
Postal Code		PostalCode
Address Type		AddressType
Address Key		AddressKey
Sub National Area		SubNationalArea
Country Name		CountryName
CountryISO3166_1_Alpha2		CountryISO3166_1_Alpha2
CountryISO3166_1_Alpha3		CountryISO3166_1_Alpha3
CountryISO3166_1_Numeric		CountryISO3166_1_Numeric
Country Subdivision Code		CountrySubdivisionCode
Thoroughfare		Thoroughfare
Thoroughfare Pre Direction		ThoroughfarePreDirection
Thoroughfare Leading Type		ThoroughfareLeadingType
Thoroughfare Name		ThoroughfareName
Thoroughfare Trailing Type		ThoroughfareTrailingType
Thoroughfare Post Direction		ThoroughfarePostDirection
Dependent Thoroughfare		DependentThoroughfare
Dependent Thoroughfare Pre Direction		DependentThoroughfarePreDirection
Dependent Thoroughfare Leading Type		DependentThoroughfareLeadingType
Dependent Thoroughfare Name		DependentThoroughfareName
Dependent Thoroughfare Trailing Type		DependentThoroughfareTrailingType
Dependent Thoroughfare Post Direction		DependentThoroughfarePostDirection
Building		Building
Premises Type		PremisesType
Premises Number		PremisesNumber
Sub Premises Type		SubPremisesType
Sub Premises Number		SubPremisesNumber
Post Box		PostBox
Latitude		Latitude
Longitude		Longitude

Response Elements

The following elements are the basic options for each request. These apply to the entire response, not the individual records.

Version

This is a string value that is the current revision number of Global Address Verification.

Protocol	Syntax
JSON	"Version":"string"
SOAP/XML	<Version>string</Version>

Transmission Reference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.

Protocol	Syntax
JSON	"TransmissionReference":"string"
SOAP/XML	<TransmissionReference>string</TransmissionReference>

Transmission Results

This is a string value that lists error codes from any errors caused by the most recent request as a whole.

For a complete list of error codes, see Global Address Verification Result Codes.

Protocol	Syntax
JSON	"TransmissionResults":"string"
SOAP/XML	<TransmissionResults>string</TransmissionResults>

Total Records

Displays the total number of records returned.

Protocol	Syntax
JSON	"TotalRecords":"string"
SOAP/XML	<TotalRecords>string</TotalRecords>

Response Record Elements

JSON will only contain the Records element.

Protocol	Definition
JSON	Each record will be contained within [{}] under the Records element.
SOAP
XML

Each of the following elements are returned for each record in the Response Array.

Record ID

This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.

Protocol	Syntax
JSON	"RecordID":"string"
SOAP/XML	<RecordID>string</RecordID>

Results

This is a string value with comma delimited status, error codes, and change codes for the record.

For a complete list of codes, see Global Address Verification Result Codes.

Protocol	Syntax
JSON	"Results":"string"
SOAP/XML	<Results>string</Results>

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.

Currently, this field is only populated for some countries. These countries are: AE, AU, BB, BE,BH, BR, BS, CA, CN, CO, CR, DK, ES, FI, FR, DM, GH, GT, GY, HK, HN, IL, IN, IS, IT, KW, LU, MY, NI, NO, NG, NZ, MX, PH, PK, PT, SA, SG, SV, TH, US, UY.

Protocol	Syntax
JSON	"CountrySubdivisionCode":"string"
SOAP/XML	<CountrySubdivisionCode>string</CountrySubdivisionCode>

Thoroughfare

This is a string value that is the parsed Thoroughfare element from the input.

Protocol	Syntax
JSON	"Thoroughfare":"string"
SOAP/XML	<Thoroughfare>string</Thoroughfare>

ThoroughfarePreDirection

This is a string value that is the parsed ThoroughfarePreDirection element from the input.

Protocol	Syntax
JSON	"ThoroughfarePreDirection":"string"
SOAP/XML	<ThoroughfarePreDirection>string</ThoroughfarePreDirection>

ThoroughfareLeadingType

This is a string value that is the parsed ThoroughfareLeadingType element from the input.

Protocol	Syntax
JSON	"ThoroughfareLeadingType":"string"
SOAP/XML	<ThoroughfareLeadingType>string</ThoroughfareLeadingType>

ThoroughfareName

This is a string value that is the parsed ThoroughfareName element from the input.

Protocol	Syntax
JSON	"ThoroughfareName":"string"
SOAP/XML	<ThoroughfareName>string</ThoroughfareName>

ThoroughfareTrailingType

This is a string value that is the parsed ThoroughfareTrailingType element from the input.

Protocol	Syntax
JSON	"ThoroughfareTrailingType":"string"
SOAP/XML	<ThoroughfareTrailingType>string</ThoroughfareTrailingType>

ThoroughfarePostDirection

This is a string value that is the parsed ThoroughfarePostDirection element from the input.

Protocol	Syntax
JSON	"ThoroughfarePostDirection":"string"
SOAP/XML	<ThoroughfarePostDirection>string</ThoroughfarePostDirection>

DependentThoroughfare

This is a string value that is the parsed DependentThoroughfare element from the input.

Protocol	Syntax
JSON	"DependentThoroughfare":"string"
SOAP/XML	<DependentThoroughfare>string</DependentThoroughfare>

DependentThoroughfarePreDirection

This is a string value that is the parsed DependentThoroughfarePreDirection element from the input.

Protocol	Syntax
JSON	"DependentThoroughfarePreDirection":"string"
SOAP/XML	<DependentThoroughfarePreDirection>string</DependentThoroughfarePreDirection>

DependentThoroughfareLeadingType

This is a string value that is the parsed DependentThoroughfareLeadingType element from the input.

Protocol	Syntax
JSON	"DependentThoroughfareLeadingType":"string"
SOAP/XML	<DependentThoroughfareLeadingType>string</DependentThoroughfareLeadingType>

DependentThoroughfareName

This is a string value that is the parsed DependentThoroughfareName element from the input.

Protocol	Syntax
JSON	"DependentThoroughfareName":"string"
SOAP/XML	<DependentThoroughfareName>string</DependentThoroughfareName>

DependentThoroughfareTrailingType

This is a string value that is the parsed DependentThoroughfareTrailingType element from the input.

Protocol	Syntax
JSON	"DependentThoroughfareTrailingType":"string"
SOAP/XML	<DependentThoroughfareTrailingType>string</DependentThoroughfareTrailingType>

DependentThoroughfarePostDirection

This is a string value that is the parsed DependentThoroughfarePostDirection element from the input.

Protocol	Syntax
JSON	"DependentThoroughfarePostDirection":"string"
SOAP/XML	<DependentThoroughfarePostDirection>string</DependentThoroughfarePostDirection>

Building

This is a string value that is the parsed Building element from the input.

Protocol	Syntax
JSON	"Building":"string"
SOAP/XML	<Building>string</Building>

PremisesType

This is a string value that is the parsed PremisesType element from the input.

Protocol	Syntax
JSON	"PremisesType":"string"
SOAP/XML	<PremisesType>string</PremisesType>

PremisesNumber

This is a string value that is the parsed PremisesNumber element from the input.

Protocol	Syntax
JSON	"PremisesNumber":"string"
SOAP/XML	<PremisesNumber>string</PremisesNumber>

SubPremisesType

This is a string value that is the parsed SubPremisesType element from the input.

Protocol	Syntax
JSON	"SubPremisesType":"string"
SOAP/XML	<SubPremisesType>string</SubPremisesType>

SubPremisesNumber

This is a string value that is the parsed SubPremisesNumber element from the input.

Protocol	Syntax
JSON	"SubPremisesNumber":"string"
SOAP/XML	<SubPremisesNumber>string</SubPremisesNumber>

PostBox

This is a string value that is the parsed PostBox element from the input.

Protocol	Syntax
JSON	"PostBox":"string"
SOAP/XML	<PostBox>string</PostBox>

Latitude

This is a string value that is the parsed Latitude element from the input.

Protocol	Syntax
JSON	"Latitude":"string"
SOAP/XML	<Latitude>string</Latitude>

Longitude

This is a string value that is the parsed Longitude element from the input.

Protocol	Syntax
JSON	"Longitude":"string"
SOAP/XML	<Longitude>string</Longitude>