# Address Validation

The Address Validation API checks the validity of U.S. domestic addresses 
and returns standardized address components in accordance with USPS® 
addressing standards. 
This helps improve delivery accuracy, reduce undeliverable mail, and 
support consistent pricing for shipping and logistics.

Endpoint: POST /api/address/validate
Version: v2
Security: BearerAuth

## Request fields (application/json):

  - `street` (string, required)
    The number of a building along with the name of the road or street on which it is located.
    Example: "xxxx Olive Street"

  - `street2` (string)
    The secondary unit designator, such as apartment(APT) or suite(STE) number, defining the exact location of the address within a building.
    Example: "STE XXX"

  - `city` (string, required)
    This is the city name of the address.
    Example: "Los Angeles"

  - `state` (string, required)
    - For U.S. addresses, this field must be a valid two-letter state code (e.g., "CA" for California, "NY" for New York).
- For non-U.S. addresses, there is no restriction on the value.
    Example: "CA"

  - `zip_code` (string, required)
    Postal code of an Address.
    Example: "021XX"

  - `country` (string, required)
    2-letter code for country. This field’s value will be an [ISO 3166-1 two-digit code](https://en.wikipedia.org/wiki/ISO_3166-1).
    Example: "US"

## Response 200 fields (application/json):

  - `code` (string)
    Result code.
    Example: "ok"

  - `msg` (string)
    Human-readable message.
    Example: "ok"

  - `data` (object)

  - `data.street` (string)
    Standardized primary street line.
    Example: "17XXX Tremont ST"

  - `data.street2` (string,null)
    Standardized secondary line, if available.

  - `data.city` (string)
    Standardized city/locality (uppercase).
    Example: "Los Angeles"

  - `data.state` (string)
    Example: "CA"

  - `data.zip` (string)
    Standardized ZIP or ZIP+4.
    Example: "02111-XXXX"

  - `data.country` (string)
    ISO 3166-1 alpha-2 country code.
    Example: "US"

  - `data.residential` (boolean)
    Whether the address is classified as residential.
    Example: true

  - `data.errored` (boolean)
    Whether validation encountered one or more errors.
    Example: true

  - `data.corrected` (boolean)
    Whether any components were corrected by the validator.
    Example: true

  - `data.standardized` (boolean)
    Whether the address is fully standardized.

  - `data.errors` (array)
    Validation errors discovered during processing.

  - `data.errors.code` (string)
    Machine-readable issue code.
    Example: "ADDRESS.SECONDARY.MISSING"

  - `data.errors.message` (string)
    Human-readable description of the issue.
    Example: "High-rise address missing secondary number."

  - `data.corrections` (array)
    Applied corrections or suggestions.

  - `data.corrections.code` (string)
    Machine-readable code.
    Example: "ADDRESS.COMPONENT.CHANGED"

  - `data.corrections.message` (string)
    Human-readable description.
    Example: "An address component (i.e., directional or suffix only) was changed"