Difference between revisions of "Global Address Verification:Response"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 495: Line 495:
  
 
:'''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.
 
:'''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.
 
:The AddressKey can be used by other Melissa Data services, such as Geocoder or RBDI.

Revision as of 00:34, 26 October 2021

← Global Address Verification

Global Address Navigation
Introduction
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
Batch JSON
Batch SOAP
Batch XML
Result Codes
Result Code Use
Global Address Verification Result Codes
Sample Code



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
Postal Code Type PostalCodeType
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
Delivery Indicator DeliveryIndicator
Melissa Address Key MelissaAddressKey
Melissa Address Key Base MelissaAddressKeyBase
Post Office Location PostOfficeLocation
Sub Premise Level SubPremiseLevel
Sub Premise Level Type SubPremiseLevelType
Sub Premise Level Number SubPremiseLevelNumber
Sub Building SubBuilding
Sub Building Type SubBuildingType
Sub Building Number SubBuildingNumber
UTC UTC
DST DST
Delivery Point Suffix DeliveryPointSuffix
Census Key CensusKey
Extras Extras


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>


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.
Protocol Syntax
JSON "PostalCodeType":"string"
SOAP/XML <PostalCodeType>string</PostalCodeType>


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, Canadian, and Great Britain addresses.
Protocol Syntax
JSON "AddressType":"string"
SOAP/XML <AddressType>string</AddressType>


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.
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, CH, CL, CN, CO, CR, DE, DK, DO, ES, FI, FR, DM, GB, GH, GT, GY, HN, IL, IN, IS, IT, JP, KW, LU, MY, NI, NL, NO, NG, NZ, MX, PH, PK, PL, PR, 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 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.
Protocol Syntax
JSON "DependentThoroughfarePreDirection":"string"
SOAP/XML <DependentThoroughfarePreDirection>string</DependentThoroughfarePreDirection>


DependentThoroughfareLeadingType

This is a string value that is the parsed DependentThoroughfareLeadingType element from the output. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfareLeadingType":"string"
SOAP/XML <DependentThoroughfareLeadingType>string</DependentThoroughfareLeadingType>


DependentThoroughfareName

This is a string value that is the parsed DependentThoroughfareName element from the output. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfareName":"string"
SOAP/XML <DependentThoroughfareName>string</DependentThoroughfareName>


DependentThoroughfareTrailingType

This is a string value that is the parsed DependentThoroughfareTrailingType element from the output. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfareTrailingType":"string"
SOAP/XML <DependentThoroughfareTrailingType>string</DependentThoroughfareTrailingType>


DependentThoroughfarePostDirection

This is a string value that is the parsed DependentThoroughfarePostDirection element from the output. This value is a part of the DependentThoroughfare field.
Protocol Syntax
JSON "DependentThoroughfarePostDirection":"string"
SOAP/XML <DependentThoroughfarePostDirection>string</DependentThoroughfarePostDirection>


Building

This is a string value that is the parsed Building element from the output.
Protocol Syntax
JSON "Building":"string"
SOAP/XML <Building>string</Building>


PremisesType

This is a string value that is the parsed PremisesType element from the output.
Protocol Syntax
JSON "PremisesType":"string"
SOAP/XML <PremisesType>string</PremisesType>


PremisesNumber

This is a string value that is the parsed PremisesNumber element from the output.
US Term: House Number
Protocol Syntax
JSON "PremisesNumber":"string"
SOAP/XML <PremisesNumber>string</PremisesNumber>


SubPremisesType

This is a string value that is the parsed SubPremisesType element from the output.
Protocol Syntax
JSON "SubPremisesType":"string"
SOAP/XML <SubPremisesType>string</SubPremisesType>


SubPremisesNumber

This is a string value that is the parsed SubPremisesNumber element from the output.
Protocol Syntax
JSON "SubPremisesNumber":"string"
SOAP/XML <SubPremisesNumber>string</SubPremisesNumber>


PostBox

This is a string value that is the parsed PostBox element from the output.
Protocol Syntax
JSON "PostBox":"string"
SOAP/XML <PostBox>string</PostBox>


Latitude

This is a string value that is the parsed Latitude element from the output.
Protocol Syntax
JSON "Latitude":"string"
SOAP/XML <Latitude>string</Latitude>


Longitude

This is a string value that is the parsed Longitude element from the output.
Protocol Syntax
JSON "Longitude":"string"
SOAP/XML <Longitude>string</Longitude>


DeliveryIndicator

This field returns 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, it is available only for the US but more countries are planned for future inclusion.
Protocol Syntax
JSON "DeliveryIndicator":"string"
SOAP/XML <DeliveryIndicator>string</DeliveryIndicator>


MelissaAddressKey

This is a globally unique and persistent key for the location, even if parts of the address change. When an address is fully validated this field returns a 10-digit proprietary key for the 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 locate addresses. Once you have a MAK it can be used as an input in most Melissa services and thus is a good tool for deduping. Currently available for US, CA, GB, IT, SI, PT, FR, AU, SG, NL, VN, BM, and TR with many more countries planned for the future.
Protocol Syntax
JSON "MelissaAddressKey":"string"
SOAP/XML <MelissaAddressKey>string</MelissaAddressKey>


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.
Protocol Syntax
JSON "MelissaAddressKeyBase":"string"
SOAP/XML <MelissaAddressKeyBase>string</MelissaAddressKeyBase>


PostOfficeLocation

This field, if available for a country, returns the value that is associated to the location of the post office in relation to the address. This value 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.
Country Description
Serbia The PostOfficeLocation contains the old 5 digit postal number and name. The postal code field will contain the new 6 digit PAK number.
Slovakia The PostOfficeLocation returns the name of the post office location if it is not the same as the delivery address locality.


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


SubPremiseLevel

This is 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. In our example, the SubPremiseLevelType is “Floor” and the SubPremiseLevelNumber is “12”.
Protocol Syntax
JSON "SubPremiseLevel":"string"
SOAP/XML <SubPremiseLevel>string</SubPremiseLevel>


SubPremiseLevelType

This is part of the SubPremiseLevel.
For example: Floor
Protocol Syntax
JSON "SubPremiseLevelType":"string"
SOAP/XML <SubPremiseLevelType>string</SubPremiseLevelType>


SubPremiseLevelNumber

This is part of the SubPremiseLevel.
For example: 12
Protocol Syntax
JSON "SubPremiseLevelNumber":"string"
SOAP/XML <SubPremiseLevelNumber>string</SubPremiseLevelNumber>


SubBuilding

This value describes 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.
Protocol Syntax
JSON "SubBuilding":"string"
SOAP/XML <SubBuilding>string</SubBuilding>


SubBuildingType

This is part of the SubBuilding.
Protocol Syntax
JSON "SubBuildingType":"string"
SOAP/XML <SubBuildingType>string</SubBuildingType>


SubBuildingNumber

This is part of the SubBuilding.
Protocol Syntax
JSON "SubBuildingNumber":"string"
SOAP/XML <SubBuildingNumber>string</SubBuildingNumber>


UTC

Returns the Coordinated Universal Time number in format of UTC+#. Note that there are timezones that are not whole hours only, like UTC+9:30.
Protocol Syntax
JSON "UTC":"string"
SOAP/XML <UTC>string</UTC>


DST

Returns a Y or a 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.
Protocol Syntax
JSON "DST":"string"
SOAP/XML <DST>string</DST>


DeliveryPointSuffix

This is a country dependent field. This field returns an identifier that represents a suffix code usually tied to a delivery point.
Code Description
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.
Protocol Syntax
JSON "DeliveryPointSuffix":"string"
SOAP/XML <DeliveryPointSuffix>string</DeliveryPointSuffix>


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.


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


Extras

Extras

This element is usually not populated but is reserved to be able to return less used fields if the user requests. Currently, we are using this to return some US only fields.

If you specify USExtras:ON in the request options, we can return additional outputs. These outputs are presented in a different format. They will look like this 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 Description
CBSA Outputs Core-Based Statistical Areas (CBSA) outputs. These values are assigned by the US Census.
  • CBSACode
  • CBSADivisionCode
  • CBSADivisionLevel
  • CBSADivisionTitle
  • CBSALevel
  • CBSATitle
CarrierRoute Carrier Route Code assigned by the USPS
CensusBlock The Census block number from the most recent yearly census
CensusTract The Census tract number from the most recent yearly census
CongressionalDistrict The congressional district number for the address
CountyFIPS The Census FIPS number from the most recent yearly census
CountyName The county name that corresponds to the county FIPS code
CountySubdivisionCode The county subdivision code value as defined by the US Census
CountySubdivisionName The county subdivision name value as defined by the US Census
DeliveryPointCheckDigit The single digit value that acts as a checksum to the delivery point code
DeliveryPointCode The 2 digit delivery point code as assigned by the USPS
ElementarySchoolDistrictCode Returns a 5 digit string representing the elementary school district code for the address
ElementarySchoolDistrictName Returns a 5 digit string representing the elementary school district code for the address
PlaceCode The FIPS Place code as defined by the Census
PlaceName The FIPS Place name as defined by the Census
SecondarySchoolDistrictCode The secondary school district code for the address
SecondarySchoolDistrictName The secondary school district name for the address
StateDistrictLower Returns a 3 digit string representing the Lower State District Code for the requested record
StateDistrictUpper Returns a 3 digit string representing the Upper State District Code for the requested record
UnifiedSchoolDistrictCode Returns a 5 digit string representing the Unified School District Code if the address is in a unified school district
UnifiedSchoolDistrictNameString Returns a 5 digit string representing the Unified School District Name if the address is in a unified school district