Address

Represents a physical address with comprehensive localization support.

Examples

```typescript
// Basic US address
const usAddress: Address = {
  address_1: "123 Main Street",
  address_2: "Apt 4B",
  city: "New York",
  country: "US",
  postal_code: "10001",
  region: "NY"
};

// US address with premise
const businessAddress: Address = {
  address_1: "1600 Pennsylvania Avenue NW",
  city: "Washington",
  country: "US",
  premise: "West Wing",
  postal_code: "20500",
  region: "DC"
};

// US address with formatting
const formattedAddress: Address = {
  address_1: "350 Fifth Avenue",
  city: "New York",
  country: "US",
  postal_code: "10118",
  region: "NY",
  formattedAddress: "350 Fifth Avenue, New York, NY 10118, US",
  localized_multi_line_address_display: [
    "350 Fifth Avenue",
    "New York, NY 10118"
  ]
};

## Fields

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `address_1` | `string` | ✓ | Primary street address line. |
| `address_2` | `string` |  | Secondary address line for apartment, suite, or unit numbers. |
| `city` | `string` | ✓ | City or locality name. |
| `country` | `string` | ✓ | Country code or name. Prefer ISO 3166-1 alpha-2 country code. |
| `premise` | `string` |  | Building or premise identifier (building name, floor, etc.). |
| `formattedAddress` | `string` |  | Complete formatted address as a single string. Useful for display purposes or geocoding services. |
| `localized_address_display` | `string` |  | Localized version of the complete address. For US addresses, typically the same as the standard format. |
| `localized_area_display` | `string` |  | Localized area/region display combining city and state. |
| `localized_multi_line_address_display` | `string[]` |  | Multi-line address display as an array of strings. Each element represents a line for proper address formatting on labels or forms. |
| `postal_code` | `string` | ✓ | US ZIP code or ZIP+4 format. |
| `region` | `string` | ✓ | US state or territory 2-letter abbreviation. |

### Field Examples

**address_1:**

```text
"123 Main Street"

"1600 Pennsylvania Avenue NW"

address_2:

"Apt 4B"

"Suite 100"

"Unit 12"

city:

"New York"

"San Francisco"

"Chicago"

country:

"US" // United States

premise:

"Building A"

"3rd Floor"

"West Wing"

formattedAddress:

"123 Main Street, Apt 4B, New York, NY 10001, US"

"1600 Pennsylvania Avenue NW, Washington, DC 20500, US"

localized_address_display:

"123 Main Street, New York, NY 10001"

localized_area_display:

"Brooklyn, NY"

"Los Angeles, CA"

"Miami, FL"

localized_multi_line_address_display:

[
  "123 Main Street",
  "Apt 4B",
  "New York, NY 10001"
]

[
  "350 Fifth Avenue",
  "New York, NY 10118"
]

postal_code:

"10001" // Standard ZIP

"10001-1234" // ZIP+4 format

"90210" // Beverly Hills ZIP

region:

"NY" // New York

"CA" // California

"TX" // Texas

"DC" // District of Columbia