US Secondary Address Data attributes
The following attributes are included in US Secondary Address Data.
Response attributes
Top-level response fields
| Field Identifier | Field Name | Definition |
|---|---|---|
smarty_ | SmartyKey® | Smarty's unique identifier for an address. |
matched_ | Matched address | Contains the street, state, and ZIP Code of the matched address. |
street | Street | Address line 1. |
state | State | The state name or abbreviation. |
zipcode | ZIP Code | The 5-digit ZIP Code. |
Address attributes
Used by both root_address and aliases
| Field Identifier | Field Name | Definition |
|---|---|---|
root_ | Root address | That base address without any secondaries. |
aliases | Aliases | All aliases of the root address. Aliases are two or more active addresses that describe the same physical location or delivery point. |
secondary_ | Secondary count | Indicates how many secondary units an address contains. |
smarty_ | SmartyKey® | Smarty's unique identifier for an address. |
primary_ | Primary number | The house, PO Box, or building number. |
street_ | Street predirection | Directional information before a street name (N, SW, etc.). |
street_ | Street name | The name of the street. |
street_ | Street suffix | Abbreviated value describing the street (St, Ave, Blvd, etc.). |
street_ | Street postdirection | Directional information after a street name (N, SW, etc.). |
city_ | City name | The USPS-preferred city name for this particular address, or an acceptable alternate if provided by the user. |
state_ | State abbreviation | The two-letter state abbreviation. |
zipcode | ZIP Code | The 5-digit ZIP Code. |
plus4_ | ZIP+4 | The 4-digit add-on code (more specific than 5-digit ZIP). |
Secondary attributes
Used by secondaries
| Field Identifier | Field Name | Definition |
|---|---|---|
secondaries | Secondaries | Lists all secondaries associated with the root address. |
smarty_ | SmartyKey® | Smarty's unique identifier for an address. |
secondary_ | Secondary designator | Describes the location within a complex/building (Ste, Apt, etc.). |
secondary_ | Secondary number | Apartment, suite, or office number, if any. |
plus4_ | ZIP+4 | The 4-digit add-on code (more specific than 5-digit ZIP). |