Addresses

Model

Address Model

This model represents our standardized address format. It handles various scenarios, from complete addresses to partial address information (such as carrier updates with limited fields). The model ensures consistent address representation across the system.

object "address"
The description of the model.

id String
The unique identifier of the address.

uuid String
A unique hash value generated by hashing address properties.

line1 String
The primary street address line.

line2 String
Additional address information such as apartment, suite, or unit number.

city String
Name of the city.

country String
The full name of the country, e.g: United States

country_code String
Two character ISO country code, e.g: US

formatted_address String
Complete address string with all components, e.g: 500 7th Ave, Fl 10, New York, NY, 10018

postal_code String
Postal code or zip code for the address.

state String
The full name of the state or region, e.g., "California"

state_code String
Standard abbreviation of the state or region if available, e.g., "CA"

textarea String
A formatted version of the address with appropriate line breaks for textarea input elements. line2 is intentionally excluded as it's typically handled by a separate input field.

timezone String
The tz database timezone name for the address location, e.g: America/Los_Angeles

verified Boolean
Indicates whether the address has been verified. Defaults to false if not specified.

coordinates [Number, Number]
Array containing [latitude, longitude] coordinates. Defaults to null if coordinates are not available.

usps_cass Object | null
Contains Coding Accuracy Support System (CASS) validation data for US addresses, as returned by the USPS CASS system. This field is only populated if CASS validation is requested and available for the address (typically for US addresses). The structure includes standardized address lines, delivery point codes, DPV (Delivery Point Validation) results, carrier route, and other USPS-specific metadata. If CASS validation is not performed or not available, this field will be null.

Show Details

Below is a table describing the fields of the usps_cass object:

Field	Type
standardized_address	object?
└─ first_address_line	string?
└─ firm	string?
└─ second_address_line	string?
└─ urbanization	string?
└─ city_state_zip_address_line	string?
└─ city	string?
└─ state	string?
└─ zip_code	string?
└─ zip_code_extension	string?
delivery_point_code	string?
delivery_point_check_digit	string?
dpv_confirmation	string?
dpv_footnote	string?
dpv_cmra	string?
dpv_vacant	string?
dpv_no_stat	string?
dpv_no_stat_reason_code	number?
dpv_drop	string?
dpv_throwback	string?
dpv_non_delivery_days	string?
dpv_non_delivery_days_values	number?
dpv_no_secure_location	string?
dpv_pbsa	string?
dpv_door_not_accessible	string?
dpv_enhanced_delivery_code	string?
carrier_route	string?
carrier_route_indicator	string?
ews_no_match	boolean?
post_office_city	string?
post_office_state	string?
abbreviated_city	string?
fips_county_code	string?
county	string?
elot_number	string?
elot_flag	string?
lacs_link_return_code	string?
lacs_link_indicator	string?
po_box_only_postal_code	boolean?
suitelink_footnote	string?
pmb_designator	string?
pmb_number	string?
address_record_type	string?
default_address	boolean?
error_message	string?
cass_processed	boolean?

hash String
The hash of the address. This hash is calculated in the same way as the hash that calculates the uuid, however it does not include the line2 value. This way, you can determine if two addresses are in the same building.

Model

# Address Model

Address Model