Addresses (3.1.2)
Download OpenAPI specification:Download
The Addresses API validates and corrects address information to improve package delivery service and pricing. This suite of APIs provides different utilities for addressing components. The ZIP Code™ lookup finds valid ZIP Code™ for a City and State. The City/State lookup provides the valid cities and states for a provided ZIP Code™. The Address Standardization API validates and standardizes USPS® domestic addresses, city, and state names, and ZIP Code™ in accordance with USPS® addressing standards. The USPS® address standard includes the ZIP + 4®, signifying a USPS® delivery point, given a street address, a city and a state.
Returns the best standardized address for a given address.
Standardizes street addresses including city and street abbreviations as well as providing missing information such as ZIP Code™ and ZIP + 4®.
Must specify a street address, a state, and either a city or a ZIP Code™.
Authorizations:
query Parameters
firm | string [ 0 .. 50 ] characters Firm/business corresponding to the address. |
streetAddress required | string The number of a building along with the name of the road or street on which it is located. |
secondaryAddress | string The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building. For more information please see Postal Explorer. |
city | string This is the city name of the address. |
state required | string = 2 characters ^(AA|AE|AL|AK|AP|AS|AZ|AR|CA|CO|CT|DE|DC|FM|F... The two-character state code of the address. |
urbanization | string This is the urbanization code relevant only for Puerto Rico addresses. |
ZIPCode | string^\d{5}$ This is the 5-digit ZIP code. |
ZIPPlus4 | string^\d{4}$ This is the 4-digit component of the ZIP+4 code. Using the correct ZIP+4 reduces the number of times your mail is handled and can decrease the chance of a misdelivery or error. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
- 503
{- "firm": "string",
- "address": {
- "streetAddress": "string",
- "streetAddressAbbreviation": "string",
- "secondaryAddress": "string",
- "cityAbbreviation": "string",
- "city": "string",
- "state": "st",
- "ZIPCode": "string",
- "ZIPPlus4": "string",
- "urbanization": "string"
}, - "additionalInfo": {
- "deliveryPoint": "string",
- "carrierRoute": "strin",
- "DPVConfirmation": "Y",
- "DPVCMRA": "Y",
- "business": "Y",
- "centralDeliveryPoint": "Y",
- "vacant": "Y"
}, - "corrections": [
- {
- "code": "s",
- "text": "string"
}
], - "matches": [
- {
- "code": "s",
- "text": "string"
}
], - "warnings": [
- "string"
]
}
Returns the city and state for a given ZIP Code.
Returns the city and state corresponding to the given ZIP Code™.
Authorizations:
query Parameters
ZIPCode required | string^\d{5}$ This is the 5-digit ZIP code. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 503
{- "city": "Des Moines",
- "state": "IA",
- "ZIPCode": "50314"
}
Returns the ZIP Code for a given address.
Returns the ZIP Code™ and ZIP + 4® corresponding to the given address, city, and state (use USPS state abbreviations).
Authorizations:
query Parameters
firm | string [ 0 .. 50 ] characters Firm/business corresponding to the address. |
streetAddress required | string The number of a building along with the name of the road or street on which it is located. |
secondaryAddress | string The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building. For more information please see Postal Explorer. |
city required | string This is the city name of the address. |
state required | string = 2 characters ^(AA|AE|AL|AK|AP|AS|AZ|AR|CA|CO|CT|DE|DC|FM|F... This is the two-character state code of the address. |
ZIPCode | string^\d{5}$ This is the 5-digit ZIP code. |
ZIPPlus4 | string^\d{4}$ This is the 4-digit component of the ZIP+4 code. Using the correct ZIP+4 reduces the number of times your mail is handled and can decrease the chance of a misdelivery or error. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
- 503
{- "firm": "string",
- "address": {
- "streetAddress": "string",
- "streetAddressAbbreviation": "string",
- "secondaryAddress": "string",
- "cityAbbreviation": "string",
- "city": "string",
- "state": "st",
- "ZIPCode": "string",
- "ZIPPlus4": "string",
- "urbanization": "string"
}
}