Table of Contents

Search

  1. Preface
  2. Introduction
  3. Address Validation Status Ports
  4. Building and Residence Data Ports
  5. Business and Organization Data Ports
  6. City and Locality Data Ports
  7. Country Data Ports
  8. Customer Segmentation Data Ports
  9. Enrichment Data Ports
  10. Formatted Data Ports
  11. Postal Carrier Certification Data Ports
  12. Postcode Data Ports
  13. Province and State Data Ports
  14. Residual Data Ports
  15. Street Data Ports
  16. Supplementary Data Ports
  17. XML Ports

Address Validator Port Reference

Address Validator Port Reference

Element Status Ports Overview

Element Status Ports Overview

The Element Input Status, Element Relevance, Element Result Status, and Extended Element Result Status ports provides status information about the validity of input and output data elements. Select the element ports to review the outcomes of an address validation operation.
The codes contain the following information:
  • Element Input Status codes represent the quality of the match found between the input address data and the reference data.
  • Element Relevance codes identify the address elements that are necessary for address delivery in the destination country.
  • Element Result Status codes describe any change made to the input data during processing.
  • Extended Element Result Status codes indicate that the address reference data contains additional information about the address element.
Each port returns a 20-character code in which each character refers to a different address data element. When you read the output codes on element ports, you must know the element that each character refers to. The 20 characters consist of 10 pairs. The two codes in each pair represent a type of address information. For example, the first position in the return code represents basic postal code information.
The Address Resolution Code port returns a 20-character string based on the same address elements as the Element Status ports.
The following table describes the address elements that the values at each position identify:
Position
Address Element
Description
Address Element Example
1
Postal code level 0
Basic postal code information, such as a five-digit ZIP Code.
The five-digit ZIP Code 10118
2
Postal code level 1
Additional postal code information, such as the final four digits of a ZIP+4 Code.
0110, in the ZIP+4 Code 10118-0110
3
Locality level 0
Primary location, such as city or town.
London, in England
4
Locality level 1
Dependent locality, suburb, village.
Islington, in London
5
Province level 0
Primary region within a country, such as a United States state name, Canadian province name, Swiss canton.
New York State
6
Province level 1
United States county name.
Queens County, in New York State
7
Street level 0
Primary street information.
South Great George's Street
8
Street level 1
Dependent street information.
George's Arcade, on South Great George's Street
9
Number level 0
Building or house number related to the primary street.
460, on South Great George's Street
10
Number level 1
Building or house number related to the dependent street.
81, on George's Arcade
11
Delivery service level 0
Case postale or post box descriptor and number.
PO Box 111
12
Delivery service level 1
Code of the post office that is responsible for delivery.
MAIN STN
13
Building level 0
Building name or number.
Does not identify a house number.
Alice Tully Hall
14
Building level 1
Additional building name or number.
Starr Theater, at Alice Tully Hall
15
Sub-building level 0
Apartment, suite, or floor name or number.
80, in 350 5th Avenue, Floor 80
16
Sub-building level 1
Apartment, suite, or floor information, when paired with Sub-building level 0 information.
80-18, where 18 is the suite number and 80 is the floor number
17
Organization level 0
Company name.
AddressDoctor GmbH
18
Organization level 1
Additional corporate information, such as a parent company.
Informatica Corporation
19
Country level 0
Country name.
United States of America
20
Country level 1
Territory.
United States Virgin Islands
When a port name has a number suffix, level 0 refers to data on port number 1 and level 1 refers to data on port numbers 2 through 6.
Level 0 information can precede or follow level 1 information in a printed address. For example, Postal code level 1 follows Postal code level 0, and Locality level 1 precedes Locality level 0.

0 COMMENTS

We’d like to hear from you!