Postal Address Verification API
PavResponse
This data response is returned by the VerifyAddressAdvanced method.
Type Properties
| Property Name | Description | Data Type | Sample |
|---|---|---|---|
| CensusInfo | Census information. | CensusInfo | |
| CityName | Address city. | String | Chesapeake |
| Country | Address country. | String | USA |
| County | The name of the county or parish in which the 5-digit ZIP Code resides. | String | CHESAPEAKE CITY |
| CountyNum | The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state. | String | 550 |
| FinanceNumber | USPS Finance Number for the address. | String | 511750 |
| FirmOrRecipient | Building or firm recipient name (if available). | String | ESENDEX |
| GeoLocationInfo | Geolocation information. | GeoLocationInfo | |
| IntelligentMailBarcodeKey | A key that can be used to obtain Intelligent Mail Barcode using GetIntelligentMailBarcode method. | String | HM3NbwIHnfyeFkCrFAClmA== |
| 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 | f233205178757f |
| PreDirectional | Direction designation. Ex: N, S, E, W | String | |
| PreferredCityName | The preferred City name. | String | Chesapeake |
| Primary | Primary street house number. | String | 505 |
| PrimaryDeliveryLine | Corrected delivery address. | String | 505 Independence Pkwy Ste 300 |
| PrimaryEO | Code identifying if Post Office considers address even, odd or both. O – Odd E – Even B – Both | String | O |
| PrimaryHigh | High-end address of range of addresses. | String | 505 |
| PrimaryLow | Low-end address of range of addresses. | String | 505 |
| ResidentialDeliveryIndicator | Whether the address is residential or commercial. Y – Address is residential N – Address is commercial | String | N |
| ReturnCode | Return status of the method call. 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 | 100 |
| Secondary | Code that describes an apartment, room, suite, space, floor, or other secondary addressing numeric or alphanumeric that follows a street address. | String | 300 |
| 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.) 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 | STE |
| SecondaryDeliveryLine | Secondary delivery address line | String | |
| SecondaryEO | Code identifying if Post Office considers secondary address even, odd or both. O – Odd E – Even B – Both | String | E |
| SecondaryHigh | Secondary high-end address of range of addresses. | String | 300 |
| SecondaryLow | Secondary low-end address of range of addresses. | String | 300 |
| StateAbbreviation | The 2-character state abbreviation. | String | VA |
| StreetName | Street name. | String | INDEPENDENCE |
| Suffix | The address suffix component. Ex: AVE, LN, DRIVE, STREET, RD | String | PKWY |
| Urbanization | Address urbanization (used in Puerto Rico only). | String | LOMAS VERDES |
| ZipCode | ZIP Code. | String | 23320-5178 |
Let’s start sending, together.