Verify and standardize input postal addresses to USPS standards.
- Parses input address into its individual elements, which may include house number, street name, street type, unit number, and more.
- Confirms deliverability using Delivery Point Validation (DPV).
- Corrects street and city name misspellings.
- Appends city and state in cases where only a street address and postal code are input.
- Appends postal code in cases where only city and state are input.
- Verifies whether delivery type is business or residential.
*- Appends time zone.
HTTP Headers
The "content-type" in the HTTP header must be set to "application/json", otherwise an HTTP 400 Bad Request response will be returned.
AddressResult
Field name | Type | Description |
---|---|---|
Address | string | Formatted full street address |
AddressRange | string | Parsed address range |
StreetName | string | Parsed street name |
Suffix | string | Parsed street suffix. i.e. St, Ave, Rd |
PostDirection | string | Parsed street post direction |
City | string | Parsed and corrected city |
CountyName | string | County name |
CountyFips | string | County FIP code |
State | string | 2 digit state abbreviation |
Zip | string | 5 digit postal code |
Zip4 | string | 4 digit Zip extension |
CountryCode | string | Country code |
CarrierRoute | string | Carrier route number |
CongressionalDistrict | string | Congressional district number |
TimeZone | string | Time zone description |
TimeZoneCode | string | Time zone code |
AddressTypeCode | string | Address type code |
Codes | array | Result |
ValidateAddress Status Codes
This section lists the following types of status codes for the ValidateAddress method
Result Codes
Code | Description |
---|---|
A1 | Address matched to postal database |
A2 | Street address match |
A3 | Non-USPS address |
A4 | Foreign postal code detected |
A5 | Address matched to CMRA |
A6 | Address has been updated by LACS |
A7 | Suite appended by Suite Link |
A8 | Address is vacant |
A9 | Alternate delivery |
A10 | DPV Error |
A11 | This address is deliverable by USPS only |
A12 | No suggestions |
A13 | Extraneous information found |
A47 | Last name reported at address |
Application Error Codes
Code | Description |
---|---|
A14 | Zip code error |
A15 | Unknown street error |
A16 | Component match error |
A17 | Non-deliverable address error |
A18 | Multiple match error |
A19 | Early warning system error |
A20 | Missing minimum address input error |
A21 | Suite range invalid error |
A22 | Suite range missing error |
A23 | Primary range invalid error |
A24 | Primary range missing error |
A25 | PO HC or RR box number invalid error |
A26 | PO HC or RR Box number missing error |
A27 | CMRA secondary missing error |
A30 | Suite range extraneous error |
Correction Codes
Code | Description |
---|---|
A33 | Zip code change |
A34 | State change |
A35 | City change |
A36 | Base alternate change |
A37 | Alias change |
A38 | Address1/address2 swap |
A39 | Address/company swap |
A40 | Plus4 change |
A41 | Urbanization Change |
A42 | Street name change |
A43 | Suffix change |
A44 | Street direction change |
A45 | Suite name change |
A46 | Suite range change |
DPV Status Codes
Code | Description |
---|---|
DPV1 | Address matched to postal database |
DPV2 | Address not matched to postal database |
DPV3 | Address matched to DPV database |
DPV4 | Input address house number matched to DPV but secondary number not matched |
DPV5 | Input address house number matched to DPV but address is missing secondary house number |
DPV6 | Input address house number missing |
DPV7 | Input address house number invalid |
DPV8 | Input address missing PO, RR, or HC box number |
DPV9 | Input address PO, RR or HC number invalid |
DPV10 | Input address matched to commercial mail handler |
DPV11 | Input address matched to commercial mail handler but secondary house number not present |
DPV12 | Address is a military address |
DPV13 | Address is a general delivery address |
DPV14 | Address was coded to a unique postal code |
Address Type Codes
Code | Description |
---|---|
F | Firm or Company address |
G | General Delivery address |
H | High Rise or Business complex |
P | PO Box address |
R | Rural Route address |
S | Street or Residential address |
HTTP Error Messages
Click to see a complete listing of error messages and codes.