Cleanse address

Validate and standardize a US address without saving it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Validate and standardize a US address without saving it. The endpoint runs the address through USPS CASS processing and returns the corrected address together with its parsed components, Delivery Point Validation (DPV) result, and postal routing metadata. No address is created or stored.

Use it to verify an address before saving it, or to power an address-verification experience.


Providing the address

Submit either a single free-form address string or the individual components (line1, city, state, postal_code, and so on). When both are provided, the explicit components take precedence.

The free-form address accepts comma-separated and multi-line input, and a trailing country (for example United States or USA) is removed automatically.


Response

The result is grouped to make it easy to consume:

GroupDescription
addressThe corrected, mailable address.
componentsThe parsed USPS address components (street, secondary unit, city, state, ZIP and ZIP+4).
dpvThe Delivery Point Validation result — whether the address is a confirmed, deliverable point, plus flags such as cmra, vacant and no_stat.
metadataPostal routing and geographic reference data: county, carrier route, congressional district, delivery point, barcode and eLOT.

The analysis is always returned, even when an address cannot be confirmed for delivery, so the result can be surfaced to the user.


Notes

  • Address cleansing currently supports US addresses only.
  • The feature must be enabled on your account; when it is not, the endpoint responds with 403.
Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
int32
required

The unique identifier of the site associated with your account.

string
length ≤ 255

A full, free-form address to cleanse (e.g. "77 Massachusetts Ave, Cambridge, MA 02139"). It is parsed into components automatically; multi-line input is supported and a trailing country (United States / USA) is removed. Provide this OR the individual components below.

string
length ≤ 255

The first line of the address (street number and name). Required unless address is provided.

string
length ≤ 255

The second line of the address (apartment, suite, unit, etc.).

string
length ≤ 255

The city, town or village.

string
length ≤ 255

The two-letter US state code.

string
length ≤ 45

The ZIP or ZIP+4 code.

string
length ≤ 255

The business name associated with the address.

string
enum
length ≤ 2
Defaults to US

The two-letter ISO 3166-1 alpha-2 country code. Address cleansing currently supports US only; defaults to "US" when omitted.

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json