Response Description

Parameter Description
AddressLine1 The first address line.
AddressLine2 The second address line.
City The city name.
Country The country code or name, in any of the following formats:
  • Two-character ISO 3116-1 Alpha-2 country code
  • Three-character ISO 3116-1 Alpha-3 country code
  • English country name
FirmName The company or firm name.
PostalCode The postal code for the address in one of the following formats:

99999

99999-9999

A9A9A9

A9A 9A9

9999 999
StateProvince The state or province.
OutputCasing Specifies the casing of the output data. It can be:

M:

The output in mixed case (default). For example:

123 Main St

Mytown FL 12345

U:

The output in upper case. For example:

123 MAIN ST

MYTOWN FL 12345
Status Reports the success or failure of the match attempt.

Null: Success

F: Failure
Status.Code Reason for failure, if there is one.
  • InsufficientInputData
  • MultipleMatchesFound
  • UnableToValidate
  • UnableToDPVConfirm
Status.Description Description of the problem, if there is one.
  • Possible Multiple Addresses Found: This value will appear if Status.Code=MultipleMatchesFound.
  • Address Not Found: This value will appear if Status.Code=UnableToValidate.
Block Address It is the formatted address, as it would appear on a physical mail piece. The block address is formatted using the standards of the applicable postal authority. For example, below is a sample block address of United States:

Parliament PL STE 600

Lanham MD 20706-1882

United States

CouldNotValidate

Mentions the address component that could not be validated, in case no match is found.

ApartmentNumber

HouseNumber

StreetName

PostalCode

City

Directional

StreetSuffix

Firm

POBoxNumber

RuralRoute
Note: More than one component may be returned, in a comma-separated list.
AddressQuality

A two character code indicating overall quality of the resulting address (For example: V5 and C3). This differences from confidence as it does not take into account how much address had to be change.

The first character indicates generally how address was processed:

C: Verified with correction

G: Verified using Geocode engine

M: Multiple addresses matching

U: Unmatched with reference data

V: Verified without change

The second character indicates the precision of the address:

5: Delivery point confirmed to be deliverable address.

4: House number or Building Name are within a valid range or known name but can not confirm 100% that premise is deliverable.

3: Street name is valid but house number may not be.

2: City exists but can not confirm street does.

1: State exists but can not confirm City does

0: can not confirm any part of address exists
AddressType

A single letter code that indicates the type of address.

F: The address is validated or corrected to the firm name.

B: The address is validated or corrected to the building name.

G: The address is a general delivery address.

H: The address is validated or corrected to the high-rise default.

L: The address is a large volume receiver.

M: The address is a military address.

P: The address is validated or corrected to PO box.

R: The address is validated or corrected to a rural route.

S: The address is validated or corrected to a street address.

U: The address type is unknown.
Locality The meaning of locality varies by country. Generally a locality is a village in rural areas or it may be a suburb in urban areas. When used, the locality typically appears in the last line of the address with the postcode.
ChangeScore

A value of 0 and 100 that reflects how much the address has changed to make it valid, excluding standardization of terms (for example: ‘street’ to ‘ST’) and mild reformatting of terms. If the address changes too much, it is risker to use.

A value of 100 means no changes to the address were needed. 0 means the address is completely invalid.

This value is used to assist the caller to determine whether the address is safe enough to use. Exactly which value to determine whether an address is safe or not depends on the use case.

A common threshold value is 75, where 75 and above is treated as safe and below 75 is considered risky, for which, confirmation would need to be sought. Other businesses might use 85 or 60 as their threshold depending on the impact of an incorrect address to their business.
Note: This field is displayed when OutputRecordType option contains A (default)
PostalCode.AddOn The 4-digit add-on part of the ZIP Code™. For example, in the ZIP Code™ 60655-1844, 1844 is the 4-digit add-on. (U.S. addresses only.)
PostalCode.Base The 5-digit ZIP Code™; for example 20706 (U.S. addresses only).
AdditionalInputData Input data not used by the address validation process