Sidebar Menu

Address

Type Properties

Property Name Description Data Type Sample
CityName

The preferred city name for the address.

String
Country

The address country.

String
County

The name of the county or parish in which the 5-digit ZIP Code resides.

String
FirmNameOrRecipient

The building or firm recipient name when available.

String
PrimaryAddressLine

The corrected primary delivery address.

String
ReturnCode

Return status of the method call.

Value Description
1

Invalid input

2

Invalid license key

10

Input address is not found

100

Input address is DPV-confirmed for all components

101

Input address is found, but not DPV-confirmed

102

Input address primary number is DPV-confirmed, secondary number is present but not DPV-confirmed

103

Input address primary number is DPV-confirmed, secondary number is missing

200

Canadian address on input, verified on city level only

Integer
SecondaryAddressLine

Secondary delivery address line (if applicable).

String
StateAbbreviation

The 2-letter state abbreviation.

String
Urbanization

The urbanization name (used in Puerto Rico only).

String
ZipCode

The corrected ZIP Code or Zip+4 (if available).

String