Unison:Global Address Verification: Difference between revisions
No edit summary |
No edit summary |
||
Line 122: | Line 122: | ||
<h3 class="productfield">Address Line 1 | <h3 class="productfield">Address Line 1 - Address Line 8</h3> | ||
:These will be the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code. | |||
: | |||
Line 163: | Line 135: | ||
<h3 class="productfield">Latitude</h3> | <h3 class="productfield">Latitude</h3> | ||
: | :The latitude of the country. | ||
<h3 class="productfield">Longitude</h3> | <h3 class="productfield">Longitude</h3> | ||
: | :The longitude of the country. | ||
<h3 class="productfield">Dependent Locality</h3> | <h3 class="productfield">Dependent Locality</h3> | ||
: | :The dependent locality. 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 | |||
<h3 class="productfield">Locality</h3> | <h3 class="productfield">Locality</h3> | ||
:''' | :The locality name. 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 | |||
<h3 class="productfield">Administrative Area/State</h3> | <h3 class="productfield">Administrative Area/State</h3> | ||
:''' | :The state/province name. This is a common geographic area unit for larger countries. | ||
:'''US Term:''' State | |||
Line 199: | Line 177: | ||
<h3 class="productfield">Address Type Code</h3> | <h3 class="productfield">Address Type Code</h3> | ||
: | :Returns a one-character code for the type of address coded. This element works only for US, Canadian, and Great Britain addresses. | ||
:See [[Result Code Details#Unison by Melissa|Unison by Melissa Result Codes]] for a full list of result codes. | |||
<h3 class="productfield">Formatted Address</h3> | <h3 class="productfield">Formatted Address</h3> | ||
: | :Returns the address in the correct format for mailing from the country specified in the Country Of Origin input. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). | ||
<h3 class="productfield">UPRN</h3> | <h3 class="productfield">UPRN</h3> | ||
: | :'''Great Britain Only'''. Returns the Unique Property Reference Number created and maintained by Ordnance Survey. | ||
Line 221: | Line 201: | ||
<h3 class="productfield">ISO 2 Country Code</h3> | <h3 class="productfield">ISO 2 Country Code</h3> | ||
: | :The 2 letter ISO 3166 country code value. | ||
:For example: | |||
:{| class="alternate01" | |||
!Country !! Code | |||
|- | |||
|United States||US | |||
|- | |||
|Canada||CA | |||
|- | |||
|Philippines||PH | |||
|} | |||
<h3 class="productfield">ISO 3 Country Code</h3> | <h3 class="productfield">ISO 3 Country Code</h3> | ||
: | :The 3 letter ISO 3166 country code value. | ||
:For example: | |||
:{| class="alternate01" | |||
!Country !! Code | |||
|- | |||
|United States||USA | |||
|- | |||
|Canada||CAN | |||
|- | |||
|Philippines||PHL | |||
|} | |||
<h3 class="productfield">ISO Country Number</h3> | <h3 class="productfield">ISO Country Number</h3> | ||
: | :The ISO 3166 country number value. | ||
:For example: | |||
:{| class="alternate01" | |||
!Country !! Code | |||
|- | |||
|United States||840 | |||
|- | |||
|Canada||124 | |||
|- | |||
|Philippines||608 | |||
|} | |||
Line 247: | Line 264: | ||
<h3 class="productfield">Dependent Thoroughfare</h3> | <h3 class="productfield">Dependent Thoroughfare</h3> | ||
: | :The parsed Dependent Thoroughfare. The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used. | ||
<h3 class="productfield">Dependent Thoroughfare Pre Direction</h3> | <h3 class="productfield">Dependent Thoroughfare Pre Direction</h3> | ||
: | :The parsed Dependent Thoroughfare Pre Direction. This value is a part of the DependentThoroughfare field. | ||
<h3 class="productfield">Dependent Thoroughfare Post Direction</h3> | <h3 class="productfield">Dependent Thoroughfare Post Direction</h3> | ||
: | :The parsed Dependent Thoroughfare Post Direction. This value is a part of the DependentThoroughfare field. | ||
<h3 class="productfield">Dependent Thoroughfare Leading Type</h3> | <h3 class="productfield">Dependent Thoroughfare Leading Type</h3> | ||
: | :The parsed Dependent Thoroughfare Leading Type. This value is a part of the DependentThoroughfare field. | ||
<h3 class="productfield">Dependent Thoroughfare Name</h3> | <h3 class="productfield">Dependent Thoroughfare Name</h3> | ||
: | :The parsed Dependent Thoroughfare Name. This value is a part of the DependentThoroughfare field. | ||
<h3 class="productfield">Dependent Thoroughfare Trailing Type</h3> | <h3 class="productfield">Dependent Thoroughfare Trailing Type</h3> | ||
: | :The parsed Dependent Thoroughfare Trailing Type. This value is a part of the DependentThoroughfare field. | ||
Line 281: | Line 298: | ||
<h3 class="productfield">Double Dependent Locality</h3> | <h3 class="productfield">Double Dependent Locality</h3> | ||
: | :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. | ||
<h3 class="productfield">Sub Administrative Area</h3> | <h3 class="productfield">Sub Administrative Area</h3> | ||
: | :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. | ||
<h3 class="productfield">Sub National Area</h3> | <h3 class="productfield">Sub National Area</h3> | ||
: | :A logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used. | ||
Line 299: | Line 316: | ||
<h3 class="productfield">Post Box</h3> | <h3 class="productfield">Post Box</h3> | ||
: | :The parsed Post Box. | ||
<h3 class="productfield">Post Office Location</h3> | <h3 class="productfield">Post Office Location</h3> | ||
: | :If available, this is 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. | ||
:{| class="alternate01" | |||
!Country !! Description | |||
|- | |||
|Serbia||The Post Office Location field contains the old 5 digit postal number and name. The postal code field will contain the new 6 digit PAK number. | |||
|- | |||
|Slovakia||The Post Office Location field returns the name of the post office location if it is not the same as the delivery address locality. | |||
|} | |||
Line 317: | Line 342: | ||
<h3 class="productfield">Premises Number/Street Number</h3> | <h3 class="productfield">Premises Number/Street Number</h3> | ||
: | :The parsed premises number. | ||
:'''US Term:''' House Number | |||
<h3 class="productfield">Premises Type</h3> | <h3 class="productfield">Premises Type</h3> | ||
: | :The parsed premises type. | ||
<h3 class="productfield">Thoroughfare</h3> | <h3 class="productfield">Thoroughfare</h3> | ||
: | :A part of the address lines containing all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc. | ||
:'''US Term:''' Street | |||
<h3 class="productfield">Thoroughfare Name</h3> | <h3 class="productfield">Thoroughfare Name</h3> | ||
: | :The parsed thoroughfare name. This is part of the thoroughfare field. | ||
<h3 class="productfield">Thoroughfare Pre Direction</h3> | <h3 class="productfield">Thoroughfare Pre Direction</h3> | ||
: | :Pre Directions are directionals at the beginning of the thoroughfare (i.e., N, S, E, W, NE, SW, etc.). This is part of the thoroughfare field. | ||
<h3 class="productfield">Thoroughfare Post Direction</h3> | <h3 class="productfield">Thoroughfare Post Direction</h3> | ||
: | :Post Directions are directionals at the end of the thoroughfare (i.e., N, S, E, W, NE, SW, etc.). This is part of the thoroughfare field. | ||
<h3 class="productfield">Thoroughfare Leading Type</h3> | <h3 class="productfield">Thoroughfare Leading Type</h3> | ||
: | :Leading Types are thoroughfare types at the beginning of the thoroughfare (i.e., "Rue", etc.). This is part of the thoroughfare field. | ||
:This term is not used in the US. | |||
<h3 class="productfield">Thoroughfare Trailing Type</h3> | <h3 class="productfield">Thoroughfare Trailing Type</h3> | ||
: | :Trailing Types are thoroughfare types at the end of the thoroughfare (i.e., "St.", "Rd.", "Ave.", etc.). This is part of the thoroughfare field. | ||
Revision as of 22:02, 8 November 2022
The Unison by Melissa Global Address Cleansing Task cleanses global contact data.
Input Fields
This section displays the possible inputs for the Global Address Cleansing Task. An address and Country are required.
Organization/Company
- The company or organization.
Address Line 1
- The first address line. 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.
Address Line 2
- The second address line. This is optional. 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.
Address Line 3
- The third address line. This is optional. 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.
Address Line 4
- The fourth address line. This is optional. 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.
Sub-Premises/Suite
- The sub-premises or suite number.
Locality/City
- The locality name.
- US Term: City
- Canada Term: Municipality
Administrative Area/State
- The administrative area, state or province name.
Postal Code/Zip
- The Zip Code or Postal Code, depending on the country.
Country
- The country code. If this is not input, the country will default to the United States.
More Input Fields
Address line 5
- The fifth address line. This is optional. 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.
Address Line 6
- The sixth address line. This is optional. 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.
Address Line 7
- The seventh address line. This is optional. 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.
Address Line 8
- The eighth address line. This is optional. 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.
Country of Origin
- This is used to determine whether or not to include the country name as the last line in Formatted Address.
- The destination country will be appended to the end of the formatted address when:
- Valid and different from the destination country.
- The destination country will not be appended to the end of the formatted address when:
- Blank or
- Invalid or
- Same as the destination country
Double Dependent Locality
- The smallest population center data element. This depends on the Locality and DependentLocality elements.
Dependent Locality/Urbanization
- The smaller population center data element. This depends on the Locality element.
- US Term: Urbanization: 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.
Sub Administrative Area/County
- The smallest geographic data element.
- US Term: County
Sub National Area
- The administrative region within a country on an arbitrary level below that of the sovereign state.
Output Fields
This section displays the possible outputs for the Address Service. Select the on/off toggle to enable/disable the output of a field.
Organization
- The company or organization.
Address Line 1 - Address Line 8
- These will be the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.
Zip/Postal Code
- The Zip or postal code.
Country
- The standard code of the country.
Latitude
- The latitude of the country.
Longitude
- The longitude of the country.
Dependent Locality
- The dependent locality. 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
Locality
- The locality name. 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
Administrative Area/State
- The state/province name. This is a common geographic area unit for larger countries.
- US Term: State
Delivery Line
Locality Line
Melissa Address Key (MAK)
- (MAK) A unique key assigned to an address record.
Melissa Address Key Base
- A unique key assigned to the base address of a complex with apartments or suites.
Address Type Code
- Returns a one-character code for the type of address coded. This element works only for US, Canadian, and Great Britain addresses.
- See Unison by Melissa Result Codes for a full list of result codes.
Formatted Address
- Returns the address in the correct format for mailing from the country specified in the Country Of Origin input. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required).
UPRN
- Great Britain Only. Returns the Unique Property Reference Number created and maintained by Ordnance Survey.
Result Codes
- Returned result codes for the address.
Additional Address Fields
Adds fields for parsed data from the address.
ISO 2 Country Code
- The 2 letter ISO 3166 country code value.
- For example:
Country Code United States US Canada CA Philippines PH
ISO 3 Country Code
- The 3 letter ISO 3166 country code value.
- For example:
Country Code United States USA Canada CAN Philippines PHL
ISO Country Number
- The ISO 3166 country number value.
- For example:
Country Code United States 840 Canada 124 Philippines 608
Formal Country Name
Country Code
Parsed Dependent Thoroughfare Fields
Adds fields relating to the Dependent Thoroughfare from the address.
Dependent Thoroughfare
- The parsed Dependent Thoroughfare. The dependent thoroughfare is a second thoroughfare that is required to narrow down the final address. This is rarely used.
Dependent Thoroughfare Pre Direction
- The parsed Dependent Thoroughfare Pre Direction. This value is a part of the DependentThoroughfare field.
Dependent Thoroughfare Post Direction
- The parsed Dependent Thoroughfare Post Direction. This value is a part of the DependentThoroughfare field.
Dependent Thoroughfare Leading Type
- The parsed Dependent Thoroughfare Leading Type. This value is a part of the DependentThoroughfare field.
Dependent Thoroughfare Name
- The parsed Dependent Thoroughfare Name. This value is a part of the DependentThoroughfare field.
Dependent Thoroughfare Trailing Type
- The parsed Dependent Thoroughfare Trailing Type. This value is a part of the DependentThoroughfare field.
Dependent Thoroughfare Type Attached
Parsed Regional Fields
Adds additional fields relating to the region from the address.
Double Dependent Locality
- 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.
Sub Administrative Area
- 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.
Sub National Area
- A logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.
Parsed Postal Facility Fields
Adds additional fields relating to the postal facility.
Post Box
- The parsed Post Box.
Post Office Location
- If available, this is 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 Post Office Location field contains the old 5 digit postal number and name. The postal code field will contain the new 6 digit PAK number. Slovakia The Post Office Location field returns the name of the post office location if it is not the same as the delivery address locality.
Parsed Thoroughfare Fields
Adds fields relating to the Thoroughfare from the address.
Premises/Street Name
Premises Number/Street Number
- The parsed premises number.
- US Term: House Number
Premises Type
- The parsed premises type.
Thoroughfare
- A part of the address lines containing all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.
- US Term: Street
Thoroughfare Name
- The parsed thoroughfare name. This is part of the thoroughfare field.
Thoroughfare Pre Direction
- Pre Directions are directionals at the beginning of the thoroughfare (i.e., N, S, E, W, NE, SW, etc.). This is part of the thoroughfare field.
Thoroughfare Post Direction
- Post Directions are directionals at the end of the thoroughfare (i.e., N, S, E, W, NE, SW, etc.). This is part of the thoroughfare field.
Thoroughfare Leading Type
- Leading Types are thoroughfare types at the beginning of the thoroughfare (i.e., "Rue", etc.). This is part of the thoroughfare field.
- This term is not used in the US.
Thoroughfare Trailing Type
- Trailing Types are thoroughfare types at the end of the thoroughfare (i.e., "St.", "Rd.", "Ave.", etc.). This is part of the thoroughfare field.
Thoroughfare Type Attached
Parsed Subpremises Fields
Adds fields relating to the sub premises from the address.
Building
Sub Building
Sub Building Number
Sub Building Type
Sub Premises/Suite
Sub Premises Type
Sub Premises Level
Sub Premises Level Number
Sub Premises Level Type
Sub Premises Number
Extra Information Fields
Adds miscellaneous fields to the output record.
Remnants
Timezone
UTC
DST
Address Key
Delivery Indicator
Census Key
Delivery Point Suffix
Delivery Line 1
Delivery Line 2
Delivery Line 3
Delivery Line 4
Delivery Line 5
Delivery Line 6
Delivery Line 7