Sidebar Menu

PavResponse

The PavResponse data type is returned by the VerifyAddressAdvanced method.

Type Properties

Property Name Description Data Type Sample
CensusInfo

Census information.

CensusInfo
CityName

Address city.

String
Country

Address country.

String
County

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

String
CountyNum

The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state.

String
FinanceNumber

USPS Finance Number for the address.

CensusInfo
FirmOrRecipient

Building or firm recipient name (if available).

String
GeoLocationInfo

Geolocation information.

GeoLocationInfo
IntelligentMailBarcodeKey

A key that can be used to obtain Intelligent Mail Barcode using GetIntelligentMailBarcode method.

String
LegislativeInfo

Legislative information.

LegislativeInfo
MailingIndustryInfo

Mailing industry information.

MailingIndustryInfo
MultipleMatches

Address information.

Array of AddressInfo objects
PMBDesignator

Private Mail Box (PMB) designator.

String
PMBNumber

Private Mail Box (PMB) number.

String
PostDirectional

Direction designation after suffix (if available). Ex: N, S, E, W.

String
PostnetBarcode

Address Bar Code.

String
PreDirectional

Direction designation. Ex: N, S, E, W

String
PreferredCityName

The preferred City name.

String
Primary

Primary street house number.

String
PrimaryDeliveryLine

Corrected delivery address.

String
PrimaryEO

Code identifying if Post Office considers address even, odd or both.

Value Description
O

Odd

E

Even

B

Both

String
PrimaryHigh

High-end address of range of addresses.

String
PrimaryLow

Low-end address of range of addresses.

String
ResidentialDeliveryIndicator

Whether the address is residential or commercial.

Value Description
Y

Address is residential

N

Address is commercial

String
ReturnCode

Return status of the method call.

Value Description
1

Invalid input

2

Invalid license key

10

Address is not found

100

Address is DPV-confirmed for all components

101

Address is found, but not DPV-confirmed

102

Address primary number is DPV-confirmed, secondary number is present but not DPV-confirmed

103

Address primary number is DPV-confirmed, secondary number is missing

200

Canadian address on input, Verified on City level only

Integer
Secondary

Code that describes an apartment, room, suite, space, floor, or other secondary addressing numeric or alphanumeric that follows a street address.

String
SecondaryAbbreviation

Abbreviation for apartment, suite, or trailer number (if applicable). (Note: Values listed here with an asterisk do not require a secondary range number to follow.)

Value Description
APT

APARTMENT

BSMT

BASEMENT *

BLDG

BUILDING

DEPT

DEPARTMENT

FL

FLOOR

FRNT

FRONT *

HNGR

HANGAR

LBBY

LOBBY *

LOT

LOT

LOWR

LOWER *

OFC

OFFICE *

PH

PENTHOUSE *

PIER

PIER

REAR

REAR *

RM

ROOM

SIDE

SIDE *

SLIP

SLIP

SPC

SPACE

STOP

STOP

STE

SUITE

TRLR

TRAILER

UNIT

UNIT

UPPR

UPPER *

String
SecondaryDeliveryLine

Secondary delivery address line

String
SecondaryEO

Code identifying if Post Office considers secondary address even, odd or both.

Value Description
O

Odd

E

Even

B

Both

String
SecondaryHigh

Secondary high-end address of range of addresses.

String
SecondaryLow

Secondary low-end address of range of addresses.

String
StateAbbreviation

The 2-character state abbreviation.

String
StreetName

Street name.

String
Suffix

The address suffix component. Ex: AVE, LN, DRIVE, STREET, RD

String
Urbanization

Address urbanization (used in Puerto Rico only).

String
ZipCode

ZIP Code.

String