# Address Verification

## Verify

**post** `/v1/addver/verifications`

1. **Structured Address** — Verify and standardize a structured address (e.g., with `line1`, `city`, etc.).
1. **Freeform Address** — Verify and standardize a freeform address written on one line. For best results, append the ISO 2-letter country code (e.g., `US`, `CA`) to the end of the line.

- Specifying `includeDetails=true` will provide additional output as documented in the `Details` schema.
- Uses 1 lookup for verification, and 1 more if geocoding (unless your contract says otherwise).

### Query Parameters

- `geocode: optional boolean`

- `includeDetails: optional boolean`

- `properCase: optional boolean`

### Body Parameters

- `body: object { address }  or object { address }`

  - `StandardFreeformAddressInput object { address }`

    - `address: string`

      The address you want to verify, written on a single line.

  - `StandardStructuredAddressInput object { address }`

    - `address: object { city, country, line1, 4 more }`

      - `city: string`

        The city of the address.

      - `country: "ca" or "us"`

        The country of your address, one of `ca` or `us`.

        - `"ca"`

        - `"us"`

      - `line1: string`

        The first line of the address.

      - `postalOrZip: string`

        The postal code or ZIP code of the address.

      - `provinceOrState: string`

        The province or state of the address.

      - `line2: optional string`

        The second line of the address.

      - `recipient: optional string`

        The optional firm/recipient name.

### Returns

- `data: object { city, country, line1, 11 more }`

  - `city: string`

    The city name of the address.

  - `country: string`

    The country code of the address.

  - `line1: string`

    The first line of the address.

  - `postalOrZip: string`

    The postal code or ZIP code of the address.

  - `provinceOrState: string`

    The province or state of the address.

  - `countryName: optional string`

    The country name of the address.

  - `details: optional object { boxID, county, countyNum, 45 more }`

    If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

    - `boxID: optional string`

      PO Box ID

    - `county: optional string`

      County in the United States (US address only)

    - `countyNum: optional string`

      FIPS code for county (US address only)

    - `deliveryInstallationAreaName: optional string`

      Delivery installation area name

    - `deliveryInstallationQualifier: optional string`

      Delivery installation qualifier

    - `deliveryInstallationType: optional string`

      Delivery installation type

    - `extraInfo: optional string`

      Any extra information relevant to the address

    - `postDirection: optional string`

      The post-direction of the street (after the street name, US addresses only)

    - `preDirection: optional string`

      The pre-direction of the street (before the street name, US addresses only)

    - `residential: optional boolean`

      Indicates that the address is residential (US address only)

    - `ruralRouteNumber: optional string`

      Rural route number

    - `ruralRouteType: optional string`

      Rural route type

    - `streetDirection: optional string`

      The direction of the street (N, S, E, W, etc)

    - `streetName: optional string`

      Name of the street where the address is located

    - `streetNumber: optional string`

      Street number (e.g. the 20 in 20 Bay St)

    - `streetType: optional string`

      Type of the street (DR, ST, BLVD, etc)

    - `suiteID: optional string`

      The unit number/name

    - `suiteKey: optional string`

      The suite key

    - `usCensusBlockNumber: optional string`

      US Census block number

    - `usCensusCMSA: optional string`

      US Census consolidated metropolitan statistical area

    - `usCensusFIPS: optional string`

      US Census FIPS code (US address only)

    - `usCensusMA: optional string`

      US Census metropolitan area

    - `usCensusMSA: optional string`

      US Census metropolitan statistical area

    - `usCensusPMSA: optional string`

      US Census primary metropolitan statistical area

    - `usCensusTractNumber: optional string`

      US Census tract number

    - `usCongressionalDistrictNumber: optional string`

      US congressional district number

    - `usHasDaylightSavings: optional boolean`

      True if address location recognizes DST

    - `usMailingCheckDigit: optional string`

      PostNet barcode digit

    - `usMailingsCarrierRoute: optional string`

      4-character code assigned to mail delivery route within a 5 digit zip code

    - `usMailingsDefaultFlag: optional boolean`

      True if US address matches a high-rise default or rural route default in the USPS data

    - `usMailingsDeliveryPoint: optional string`

      Unique USPS identifier for the delivery point

    - `usMailingsDpvConfirmationIndicator: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsDpvCrmaIndicator: optional string`

      Y if this is a commercial mail receiving agency, N otherwise

    - `usMailingsDpvFootnote1: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsDpvFootnote2: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsDpvFootnote3: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsElotAscDesc: optional string`

      A for ascending, D for descending

    - `usMailingsElotSequenceNumber: optional string`

      eLOT sequence number

    - `usMailingsEWSFlag: optional string`

      Y if address is in early warning system database

    - `usMailingsLACSFlag: optional string`

      Y if address converted by LACS

    - `usMailingsLACSReturnCode: optional string`

      Corresponds to USPS LACSLink return code

    - `usMailingsRecordTypeCode: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsSuiteLinkReturnCode: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usPostnetBarcode: optional string`

      PostNet barcode for the address (US address only)

    - `usStateLegislativeLower: optional string`

      Lower legislative district for the US address

    - `usStateLegislativeUpper: optional string`

      Upper legislative district for the US address

    - `usTimeZone: optional string`

      Time zone for the US address area

    - `vacant: optional boolean`

      Indicates that the address is vacant according to the USPS (US address only)

  - `errors: optional Errors`

    Errors encountered during address verification.

    - `city: optional array of string`

      Errors related to the city.

    - `generic: optional array of string`

      Generic errors not tied to a specific field.

    - `line1: optional array of string`

      Errors related to the first address line.

    - `line2: optional array of string`

      Errors related to the second address line.

    - `postalOrZip: optional array of string`

      Errors related to the postal or ZIP code.

    - `provinceOrState: optional array of string`

      Errors related to the province or state.

  - `firmName: optional string`

    The firm name of the address.

  - `geocodeResult: optional object { accuracy, accuracyType, location }`

    If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
    which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
    this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
    verification, suggestions, and POST /completions endpoint. Note that you must supply country when
    geocoding to get the result successfully.

    - `accuracy: number`

      A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

    - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

      A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

      - `"rooftop"`

      - `"point"`

      - `"range_interpolation"`

      - `"nearest_rooftop_match"`

      - `"intersection"`

      - `"street_center"`

      - `"place"`

      - `"state"`

    - `location: object { lat, lng }`

      Object that contains `lat`, `lng` properties with number values

      - `lat: number`

      - `lng: number`

  - `line2: optional string`

    The second line of the address.

  - `provinceOrStateName: optional string`

    The full name of the province or state.

  - `status: optional Status`

    The verification status of an address.

    - `"verified"`

    - `"corrected"`

    - `"failed"`

  - `zipPlus4: optional string`

    The zip plus 4 code of the address.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/verifications \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "address": "address"
        }'
```

#### Response

```json
{
  "status": "success",
  "message": "Address verified successfully",
  "data": {
    "city": "Los Angeles",
    "country": "US",
    "line1": "1234 Elm St",
    "postalOrZip": "90001",
    "provinceOrState": "CA",
    "status": "verified",
    "errors": {}
  }
}
```

## Get Lookup Info

**get** `/v1/addver/`

Returns your organization's current lookup usage and plan information.
Useful for checking how many lookups you have consumed and whether you
are on a paid plan.

### Returns

- `data: object { freeLimit, used }`

  - `freeLimit: number`

    The maximum number of lookups allowed in the current billing period.
    `null` indicates an unlimited plan.

  - `used: number`

    The number of lookups consumed in the current billing period.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/ \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY"
```

#### Response

```json
{
  "data": {
    "freeLimit": 0,
    "used": 0
  },
  "message": "message",
  "status": "success"
}
```

## Get Autocomplete Previews

**get** `/v1/addver/completions`

Returns address completion previews for a partial street address, suitable
for populating an autocomplete dropdown without consuming a lookup per keystroke.

Each result contains a partial address preview (street, city, and — for non-US
addresses — only the first 3 digits of the postal code, to avoid revealing the
full code before a lookup is charged).

- Does not consume a lookup.
- Use `POST /completions` to resolve a full address once the user selects a result.

### Query Parameters

- `partialStreet: string`

- `cityFilter: optional string`

- `countryFilter: optional string`

- `filterExact: optional boolean`

- `limit: optional number`

- `pcFilter: optional string`

- `properCase: optional boolean`

- `provInsteadOfPC: optional boolean`

- `stateFilter: optional string`

- `verifiedOnly: optional boolean`

### Returns

- `data: array of object { preview }`

  - `preview: object { address, city, pc, prov }`

    A partial view of the address, suitable for display in an autocomplete dropdown.

    - `address: string`

      The street address line.

    - `city: optional string`

      The city.

    - `pc: optional string`

      For US addresses, the full postal code. For non-US addresses,
      only the first 3 digits are returned to avoid consuming a lookup.

    - `prov: optional string`

      The province or state abbreviation. Returned instead of `pc` when `provInsteadOfPC=true`.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/completions \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY"
```

#### Response

```json
{
  "data": [
    {
      "preview": {
        "address": "address",
        "city": "city",
        "pc": "pc",
        "prov": "prov"
      }
    }
  ],
  "message": "message",
  "status": "success"
}
```

## Autocomplete

**post** `/v1/addver/completions`

Resolves a partial street address into a list of full address candidates,
optionally selecting a specific candidate by index and verifying it.

**Basic usage** — omit `index`: returns an array of `CompletedAddressItem`
results for the given `partialStreet`.

**With `index`** — specify `index` to resolve a single candidate. Returns
a single `CompletedAddressItem`.

**With `index` + `verify=true`** — additionally runs the selected address
through the USPS/Canada Post verifier and returns a `StandardVerifiedAddress`.

- Uses 1 lookup per call (plus 1 more if geocoding a result).

### Query Parameters

- `filterExact: optional boolean`

- `geocode: optional boolean`

- `includeDetails: optional boolean`

- `index: optional number`

- `limit: optional number`

- `properCase: optional boolean`

- `verifiedOnly: optional boolean`

- `verify: optional boolean`

### Body Parameters

- `partialStreet: string`

  The partial street address to complete (e.g. `"22 Bay"`).

- `cityFilter: optional string`

  Filter results to a specific city.

- `countryFilter: optional string`

  Filter results to a specific country code.

- `pcFilter: optional string`

  Filter results to a specific postal code prefix.

- `stateFilter: optional string`

  Filter results to a specific state or province abbreviation.

- `verifiedOnly: optional boolean`

  If true, only return addresses that passed USPS/Canada Post verification.

### Returns

- `data: object { address, errors, geocodeResult }  or array of object { address, errors, geocodeResult }  or object { city, country, line1, 11 more }`

  - `CompletedAddressItem object { address, errors, geocodeResult }`

    - `address: object { address, address2, city, 3 more }`

      The resolved address components.

      - `address: string`

        The first line of the address.

      - `address2: optional string`

        The second line of the address.

      - `city: optional string`

        The city.

      - `country: optional string`

        The ISO 2-letter country code.

      - `pc: optional string`

        The postal code.

      - `prov: optional string`

        The province or state abbreviation.

    - `errors: optional Errors`

      Errors encountered during address verification.

      - `city: optional array of string`

        Errors related to the city.

      - `generic: optional array of string`

        Generic errors not tied to a specific field.

      - `line1: optional array of string`

        Errors related to the first address line.

      - `line2: optional array of string`

        Errors related to the second address line.

      - `postalOrZip: optional array of string`

        Errors related to the postal or ZIP code.

      - `provinceOrState: optional array of string`

        Errors related to the province or state.

    - `geocodeResult: optional object { accuracy, accuracyType, location }`

      Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified.

      - `accuracy: number`

        A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

      - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

        A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

        - `"rooftop"`

        - `"point"`

        - `"range_interpolation"`

        - `"nearest_rooftop_match"`

        - `"intersection"`

        - `"street_center"`

        - `"place"`

        - `"state"`

      - `location: object { lat, lng }`

        Object that contains `lat`, `lng` properties with number values

        - `lat: number`

        - `lng: number`

  - `array of object { address, errors, geocodeResult }`

    - `address: object { address, address2, city, 3 more }`

      The resolved address components.

      - `address: string`

        The first line of the address.

      - `address2: optional string`

        The second line of the address.

      - `city: optional string`

        The city.

      - `country: optional string`

        The ISO 2-letter country code.

      - `pc: optional string`

        The postal code.

      - `prov: optional string`

        The province or state abbreviation.

    - `errors: optional Errors`

      Errors encountered during address verification.

    - `geocodeResult: optional object { accuracy, accuracyType, location }`

      Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified.

      - `accuracy: number`

        A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

      - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

        A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

        - `"rooftop"`

        - `"point"`

        - `"range_interpolation"`

        - `"nearest_rooftop_match"`

        - `"intersection"`

        - `"street_center"`

        - `"place"`

        - `"state"`

      - `location: object { lat, lng }`

        Object that contains `lat`, `lng` properties with number values

        - `lat: number`

        - `lng: number`

  - `StandardVerifiedAddress object { city, country, line1, 11 more }`

    - `city: string`

      The city name of the address.

    - `country: string`

      The country code of the address.

    - `line1: string`

      The first line of the address.

    - `postalOrZip: string`

      The postal code or ZIP code of the address.

    - `provinceOrState: string`

      The province or state of the address.

    - `countryName: optional string`

      The country name of the address.

    - `details: optional object { boxID, county, countyNum, 45 more }`

      If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

      - `boxID: optional string`

        PO Box ID

      - `county: optional string`

        County in the United States (US address only)

      - `countyNum: optional string`

        FIPS code for county (US address only)

      - `deliveryInstallationAreaName: optional string`

        Delivery installation area name

      - `deliveryInstallationQualifier: optional string`

        Delivery installation qualifier

      - `deliveryInstallationType: optional string`

        Delivery installation type

      - `extraInfo: optional string`

        Any extra information relevant to the address

      - `postDirection: optional string`

        The post-direction of the street (after the street name, US addresses only)

      - `preDirection: optional string`

        The pre-direction of the street (before the street name, US addresses only)

      - `residential: optional boolean`

        Indicates that the address is residential (US address only)

      - `ruralRouteNumber: optional string`

        Rural route number

      - `ruralRouteType: optional string`

        Rural route type

      - `streetDirection: optional string`

        The direction of the street (N, S, E, W, etc)

      - `streetName: optional string`

        Name of the street where the address is located

      - `streetNumber: optional string`

        Street number (e.g. the 20 in 20 Bay St)

      - `streetType: optional string`

        Type of the street (DR, ST, BLVD, etc)

      - `suiteID: optional string`

        The unit number/name

      - `suiteKey: optional string`

        The suite key

      - `usCensusBlockNumber: optional string`

        US Census block number

      - `usCensusCMSA: optional string`

        US Census consolidated metropolitan statistical area

      - `usCensusFIPS: optional string`

        US Census FIPS code (US address only)

      - `usCensusMA: optional string`

        US Census metropolitan area

      - `usCensusMSA: optional string`

        US Census metropolitan statistical area

      - `usCensusPMSA: optional string`

        US Census primary metropolitan statistical area

      - `usCensusTractNumber: optional string`

        US Census tract number

      - `usCongressionalDistrictNumber: optional string`

        US congressional district number

      - `usHasDaylightSavings: optional boolean`

        True if address location recognizes DST

      - `usMailingCheckDigit: optional string`

        PostNet barcode digit

      - `usMailingsCarrierRoute: optional string`

        4-character code assigned to mail delivery route within a 5 digit zip code

      - `usMailingsDefaultFlag: optional boolean`

        True if US address matches a high-rise default or rural route default in the USPS data

      - `usMailingsDeliveryPoint: optional string`

        Unique USPS identifier for the delivery point

      - `usMailingsDpvConfirmationIndicator: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvCrmaIndicator: optional string`

        Y if this is a commercial mail receiving agency, N otherwise

      - `usMailingsDpvFootnote1: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvFootnote2: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvFootnote3: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsElotAscDesc: optional string`

        A for ascending, D for descending

      - `usMailingsElotSequenceNumber: optional string`

        eLOT sequence number

      - `usMailingsEWSFlag: optional string`

        Y if address is in early warning system database

      - `usMailingsLACSFlag: optional string`

        Y if address converted by LACS

      - `usMailingsLACSReturnCode: optional string`

        Corresponds to USPS LACSLink return code

      - `usMailingsRecordTypeCode: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsSuiteLinkReturnCode: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usPostnetBarcode: optional string`

        PostNet barcode for the address (US address only)

      - `usStateLegislativeLower: optional string`

        Lower legislative district for the US address

      - `usStateLegislativeUpper: optional string`

        Upper legislative district for the US address

      - `usTimeZone: optional string`

        Time zone for the US address area

      - `vacant: optional boolean`

        Indicates that the address is vacant according to the USPS (US address only)

    - `errors: optional Errors`

      Errors encountered during address verification.

    - `firmName: optional string`

      The firm name of the address.

    - `geocodeResult: optional object { accuracy, accuracyType, location }`

      If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
      which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
      this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
      verification, suggestions, and POST /completions endpoint. Note that you must supply country when
      geocoding to get the result successfully.

      - `accuracy: number`

        A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

      - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

        A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

        - `"rooftop"`

        - `"point"`

        - `"range_interpolation"`

        - `"nearest_rooftop_match"`

        - `"intersection"`

        - `"street_center"`

        - `"place"`

        - `"state"`

      - `location: object { lat, lng }`

        Object that contains `lat`, `lng` properties with number values

        - `lat: number`

        - `lng: number`

    - `line2: optional string`

      The second line of the address.

    - `provinceOrStateName: optional string`

      The full name of the province or state.

    - `status: optional Status`

      The verification status of an address.

      - `"verified"`

      - `"corrected"`

      - `"failed"`

    - `zipPlus4: optional string`

      The zip plus 4 code of the address.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/completions \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "partialStreet": "partialStreet"
        }'
```

#### Response

```json
{
  "data": {
    "address": {
      "address": "address",
      "address2": "address2",
      "city": "city",
      "country": "country",
      "pc": "pc",
      "prov": "prov"
    },
    "errors": {
      "city": [
        "string"
      ],
      "generic": [
        "string"
      ],
      "line1": [
        "string"
      ],
      "line2": [
        "string"
      ],
      "postalOrZip": [
        "string"
      ],
      "provinceOrState": [
        "string"
      ]
    },
    "geocodeResult": {
      "accuracy": 0,
      "accuracyType": "rooftop",
      "location": {
        "lat": 0,
        "lng": 0
      }
    }
  },
  "message": "message",
  "status": "success"
}
```

## Batch Verification

**post** `/v1/addver/verifications/batch`

Verify a batch of US or Canadian addresses in a single request.
Each address can be freeform or structured, matching the same input formats
accepted by the single verification endpoint.

- Uses 1 lookup per address (plus 1 more per address if geocoding).
- Requires a secret API key.
- Returns results in the same order as the input addresses.
- If an individual address fails, its result will contain an `error` field
  rather than a `verifiedAddress`.

### Query Parameters

- `geocode: optional boolean`

- `includeDetails: optional boolean`

- `properCase: optional boolean`

### Body Parameters

- `addresses: array of object { address }  or object { address }`

  Array of addresses to verify. Each item can be a freeform string or structured address object.

  - `StandardFreeformAddressInput object { address }`

    - `address: string`

      The address you want to verify, written on a single line.

  - `StandardStructuredAddressInput object { address }`

    - `address: object { city, country, line1, 4 more }`

      - `city: string`

        The city of the address.

      - `country: "ca" or "us"`

        The country of your address, one of `ca` or `us`.

        - `"ca"`

        - `"us"`

      - `line1: string`

        The first line of the address.

      - `postalOrZip: string`

        The postal code or ZIP code of the address.

      - `provinceOrState: string`

        The province or state of the address.

      - `line2: optional string`

        The second line of the address.

      - `recipient: optional string`

        The optional firm/recipient name.

### Returns

- `data: object { results }`

  - `results: array of object { error, verifiedAddress }`

    - `error: optional string`

      An error message for this address. Present when verification failed.

    - `verifiedAddress: optional object { city, country, line1, 11 more }`

      The verified address result. Present when verification succeeded.

      - `city: string`

        The city name of the address.

      - `country: string`

        The country code of the address.

      - `line1: string`

        The first line of the address.

      - `postalOrZip: string`

        The postal code or ZIP code of the address.

      - `provinceOrState: string`

        The province or state of the address.

      - `countryName: optional string`

        The country name of the address.

      - `details: optional object { boxID, county, countyNum, 45 more }`

        If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

        - `boxID: optional string`

          PO Box ID

        - `county: optional string`

          County in the United States (US address only)

        - `countyNum: optional string`

          FIPS code for county (US address only)

        - `deliveryInstallationAreaName: optional string`

          Delivery installation area name

        - `deliveryInstallationQualifier: optional string`

          Delivery installation qualifier

        - `deliveryInstallationType: optional string`

          Delivery installation type

        - `extraInfo: optional string`

          Any extra information relevant to the address

        - `postDirection: optional string`

          The post-direction of the street (after the street name, US addresses only)

        - `preDirection: optional string`

          The pre-direction of the street (before the street name, US addresses only)

        - `residential: optional boolean`

          Indicates that the address is residential (US address only)

        - `ruralRouteNumber: optional string`

          Rural route number

        - `ruralRouteType: optional string`

          Rural route type

        - `streetDirection: optional string`

          The direction of the street (N, S, E, W, etc)

        - `streetName: optional string`

          Name of the street where the address is located

        - `streetNumber: optional string`

          Street number (e.g. the 20 in 20 Bay St)

        - `streetType: optional string`

          Type of the street (DR, ST, BLVD, etc)

        - `suiteID: optional string`

          The unit number/name

        - `suiteKey: optional string`

          The suite key

        - `usCensusBlockNumber: optional string`

          US Census block number

        - `usCensusCMSA: optional string`

          US Census consolidated metropolitan statistical area

        - `usCensusFIPS: optional string`

          US Census FIPS code (US address only)

        - `usCensusMA: optional string`

          US Census metropolitan area

        - `usCensusMSA: optional string`

          US Census metropolitan statistical area

        - `usCensusPMSA: optional string`

          US Census primary metropolitan statistical area

        - `usCensusTractNumber: optional string`

          US Census tract number

        - `usCongressionalDistrictNumber: optional string`

          US congressional district number

        - `usHasDaylightSavings: optional boolean`

          True if address location recognizes DST

        - `usMailingCheckDigit: optional string`

          PostNet barcode digit

        - `usMailingsCarrierRoute: optional string`

          4-character code assigned to mail delivery route within a 5 digit zip code

        - `usMailingsDefaultFlag: optional boolean`

          True if US address matches a high-rise default or rural route default in the USPS data

        - `usMailingsDeliveryPoint: optional string`

          Unique USPS identifier for the delivery point

        - `usMailingsDpvConfirmationIndicator: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsDpvCrmaIndicator: optional string`

          Y if this is a commercial mail receiving agency, N otherwise

        - `usMailingsDpvFootnote1: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsDpvFootnote2: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsDpvFootnote3: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsElotAscDesc: optional string`

          A for ascending, D for descending

        - `usMailingsElotSequenceNumber: optional string`

          eLOT sequence number

        - `usMailingsEWSFlag: optional string`

          Y if address is in early warning system database

        - `usMailingsLACSFlag: optional string`

          Y if address converted by LACS

        - `usMailingsLACSReturnCode: optional string`

          Corresponds to USPS LACSLink return code

        - `usMailingsRecordTypeCode: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsSuiteLinkReturnCode: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usPostnetBarcode: optional string`

          PostNet barcode for the address (US address only)

        - `usStateLegislativeLower: optional string`

          Lower legislative district for the US address

        - `usStateLegislativeUpper: optional string`

          Upper legislative district for the US address

        - `usTimeZone: optional string`

          Time zone for the US address area

        - `vacant: optional boolean`

          Indicates that the address is vacant according to the USPS (US address only)

      - `errors: optional Errors`

        Errors encountered during address verification.

        - `city: optional array of string`

          Errors related to the city.

        - `generic: optional array of string`

          Generic errors not tied to a specific field.

        - `line1: optional array of string`

          Errors related to the first address line.

        - `line2: optional array of string`

          Errors related to the second address line.

        - `postalOrZip: optional array of string`

          Errors related to the postal or ZIP code.

        - `provinceOrState: optional array of string`

          Errors related to the province or state.

      - `firmName: optional string`

        The firm name of the address.

      - `geocodeResult: optional object { accuracy, accuracyType, location }`

        If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
        which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
        this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
        verification, suggestions, and POST /completions endpoint. Note that you must supply country when
        geocoding to get the result successfully.

        - `accuracy: number`

          A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

        - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

          A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

          - `"rooftop"`

          - `"point"`

          - `"range_interpolation"`

          - `"nearest_rooftop_match"`

          - `"intersection"`

          - `"street_center"`

          - `"place"`

          - `"state"`

        - `location: object { lat, lng }`

          Object that contains `lat`, `lng` properties with number values

          - `lat: number`

          - `lng: number`

      - `line2: optional string`

        The second line of the address.

      - `provinceOrStateName: optional string`

        The full name of the province or state.

      - `status: optional Status`

        The verification status of an address.

        - `"verified"`

        - `"corrected"`

        - `"failed"`

      - `zipPlus4: optional string`

        The zip plus 4 code of the address.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/verifications/batch \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "addresses": [
            {
              "address": "address"
            }
          ]
        }'
```

#### Response

```json
{
  "data": {
    "results": [
      {
        "error": "error",
        "verifiedAddress": {
          "city": "city",
          "country": "country",
          "line1": "line1",
          "postalOrZip": "postalOrZip",
          "provinceOrState": "provinceOrState",
          "countryName": "countryName",
          "details": {
            "boxID": "boxID",
            "county": "county",
            "countyNum": "countyNum",
            "deliveryInstallationAreaName": "deliveryInstallationAreaName",
            "deliveryInstallationQualifier": "deliveryInstallationQualifier",
            "deliveryInstallationType": "deliveryInstallationType",
            "extraInfo": "extraInfo",
            "postDirection": "postDirection",
            "preDirection": "preDirection",
            "residential": true,
            "ruralRouteNumber": "ruralRouteNumber",
            "ruralRouteType": "ruralRouteType",
            "streetDirection": "streetDirection",
            "streetName": "streetName",
            "streetNumber": "streetNumber",
            "streetType": "streetType",
            "suiteID": "suiteID",
            "suiteKey": "suiteKey",
            "usCensusBlockNumber": "usCensusBlockNumber",
            "usCensusCMSA": "usCensusCMSA",
            "usCensusFIPS": "usCensusFIPS",
            "usCensusMA": "usCensusMA",
            "usCensusMSA": "usCensusMSA",
            "usCensusPMSA": "usCensusPMSA",
            "usCensusTractNumber": "usCensusTractNumber",
            "usCongressionalDistrictNumber": "usCongressionalDistrictNumber",
            "usHasDaylightSavings": true,
            "usMailingCheckDigit": "usMailingCheckDigit",
            "usMailingsCarrierRoute": "usMailingsCarrierRoute",
            "usMailingsDefaultFlag": true,
            "usMailingsDeliveryPoint": "usMailingsDeliveryPoint",
            "usMailingsDpvConfirmationIndicator": "usMailingsDpvConfirmationIndicator",
            "usMailingsDpvCrmaIndicator": "usMailingsDpvCrmaIndicator",
            "usMailingsDpvFootnote1": "usMailingsDpvFootnote1",
            "usMailingsDpvFootnote2": "usMailingsDpvFootnote2",
            "usMailingsDpvFootnote3": "usMailingsDpvFootnote3",
            "usMailingsElotAscDesc": "usMailingsElotAscDesc",
            "usMailingsElotSequenceNumber": "usMailingsElotSequenceNumber",
            "usMailingsEWSFlag": "usMailingsEWSFlag",
            "usMailingsLACSFlag": "usMailingsLACSFlag",
            "usMailingsLACSReturnCode": "usMailingsLACSReturnCode",
            "usMailingsRecordTypeCode": "usMailingsRecordTypeCode",
            "usMailingsSuiteLinkReturnCode": "usMailingsSuiteLinkReturnCode",
            "usPostnetBarcode": "usPostnetBarcode",
            "usStateLegislativeLower": "usStateLegislativeLower",
            "usStateLegislativeUpper": "usStateLegislativeUpper",
            "usTimeZone": "usTimeZone",
            "vacant": true
          },
          "errors": {
            "city": [
              "string"
            ],
            "generic": [
              "string"
            ],
            "line1": [
              "string"
            ],
            "line2": [
              "string"
            ],
            "postalOrZip": [
              "string"
            ],
            "provinceOrState": [
              "string"
            ]
          },
          "firmName": "firmName",
          "geocodeResult": {
            "accuracy": 0,
            "accuracyType": "rooftop",
            "location": {
              "lat": 0,
              "lng": 0
            }
          },
          "line2": "line2",
          "provinceOrStateName": "provinceOrStateName",
          "status": "verified",
          "zipPlus4": "zipPlus4"
        }
      }
    ]
  },
  "message": "message",
  "status": "success"
}
```

## Suggest Addresses

**post** `/v1/addver/suggestions`

Returns up to 3 verified address suggestions for a given input address.

Useful as a fallback when `POST /verifications` returns a `failed` status —
suggestions represent the closest matches found and may help the user
identify the correct address.

Accepts the same freeform or structured input formats as `POST /verifications`.

- Uses 1 lookup per call (plus 1 more if geocoding).

### Query Parameters

- `geocode: optional boolean`

- `includeDetails: optional boolean`

- `properCase: optional boolean`

### Body Parameters

- `body: object { address }  or object { address }`

  - `StandardFreeformAddressInput object { address }`

    - `address: string`

      The address you want to verify, written on a single line.

  - `StandardStructuredAddressInput object { address }`

    - `address: object { city, country, line1, 4 more }`

      - `city: string`

        The city of the address.

      - `country: "ca" or "us"`

        The country of your address, one of `ca` or `us`.

        - `"ca"`

        - `"us"`

      - `line1: string`

        The first line of the address.

      - `postalOrZip: string`

        The postal code or ZIP code of the address.

      - `provinceOrState: string`

        The province or state of the address.

      - `line2: optional string`

        The second line of the address.

      - `recipient: optional string`

        The optional firm/recipient name.

### Returns

- `data: array of object { city, country, line1, 11 more }`

  - `city: string`

    The city name of the address.

  - `country: string`

    The country code of the address.

  - `line1: string`

    The first line of the address.

  - `postalOrZip: string`

    The postal code or ZIP code of the address.

  - `provinceOrState: string`

    The province or state of the address.

  - `countryName: optional string`

    The country name of the address.

  - `details: optional object { boxID, county, countyNum, 45 more }`

    If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

    - `boxID: optional string`

      PO Box ID

    - `county: optional string`

      County in the United States (US address only)

    - `countyNum: optional string`

      FIPS code for county (US address only)

    - `deliveryInstallationAreaName: optional string`

      Delivery installation area name

    - `deliveryInstallationQualifier: optional string`

      Delivery installation qualifier

    - `deliveryInstallationType: optional string`

      Delivery installation type

    - `extraInfo: optional string`

      Any extra information relevant to the address

    - `postDirection: optional string`

      The post-direction of the street (after the street name, US addresses only)

    - `preDirection: optional string`

      The pre-direction of the street (before the street name, US addresses only)

    - `residential: optional boolean`

      Indicates that the address is residential (US address only)

    - `ruralRouteNumber: optional string`

      Rural route number

    - `ruralRouteType: optional string`

      Rural route type

    - `streetDirection: optional string`

      The direction of the street (N, S, E, W, etc)

    - `streetName: optional string`

      Name of the street where the address is located

    - `streetNumber: optional string`

      Street number (e.g. the 20 in 20 Bay St)

    - `streetType: optional string`

      Type of the street (DR, ST, BLVD, etc)

    - `suiteID: optional string`

      The unit number/name

    - `suiteKey: optional string`

      The suite key

    - `usCensusBlockNumber: optional string`

      US Census block number

    - `usCensusCMSA: optional string`

      US Census consolidated metropolitan statistical area

    - `usCensusFIPS: optional string`

      US Census FIPS code (US address only)

    - `usCensusMA: optional string`

      US Census metropolitan area

    - `usCensusMSA: optional string`

      US Census metropolitan statistical area

    - `usCensusPMSA: optional string`

      US Census primary metropolitan statistical area

    - `usCensusTractNumber: optional string`

      US Census tract number

    - `usCongressionalDistrictNumber: optional string`

      US congressional district number

    - `usHasDaylightSavings: optional boolean`

      True if address location recognizes DST

    - `usMailingCheckDigit: optional string`

      PostNet barcode digit

    - `usMailingsCarrierRoute: optional string`

      4-character code assigned to mail delivery route within a 5 digit zip code

    - `usMailingsDefaultFlag: optional boolean`

      True if US address matches a high-rise default or rural route default in the USPS data

    - `usMailingsDeliveryPoint: optional string`

      Unique USPS identifier for the delivery point

    - `usMailingsDpvConfirmationIndicator: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsDpvCrmaIndicator: optional string`

      Y if this is a commercial mail receiving agency, N otherwise

    - `usMailingsDpvFootnote1: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsDpvFootnote2: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsDpvFootnote3: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsElotAscDesc: optional string`

      A for ascending, D for descending

    - `usMailingsElotSequenceNumber: optional string`

      eLOT sequence number

    - `usMailingsEWSFlag: optional string`

      Y if address is in early warning system database

    - `usMailingsLACSFlag: optional string`

      Y if address converted by LACS

    - `usMailingsLACSReturnCode: optional string`

      Corresponds to USPS LACSLink return code

    - `usMailingsRecordTypeCode: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usMailingsSuiteLinkReturnCode: optional string`

      See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

    - `usPostnetBarcode: optional string`

      PostNet barcode for the address (US address only)

    - `usStateLegislativeLower: optional string`

      Lower legislative district for the US address

    - `usStateLegislativeUpper: optional string`

      Upper legislative district for the US address

    - `usTimeZone: optional string`

      Time zone for the US address area

    - `vacant: optional boolean`

      Indicates that the address is vacant according to the USPS (US address only)

  - `errors: optional Errors`

    Errors encountered during address verification.

    - `city: optional array of string`

      Errors related to the city.

    - `generic: optional array of string`

      Generic errors not tied to a specific field.

    - `line1: optional array of string`

      Errors related to the first address line.

    - `line2: optional array of string`

      Errors related to the second address line.

    - `postalOrZip: optional array of string`

      Errors related to the postal or ZIP code.

    - `provinceOrState: optional array of string`

      Errors related to the province or state.

  - `firmName: optional string`

    The firm name of the address.

  - `geocodeResult: optional object { accuracy, accuracyType, location }`

    If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
    which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
    this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
    verification, suggestions, and POST /completions endpoint. Note that you must supply country when
    geocoding to get the result successfully.

    - `accuracy: number`

      A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

    - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

      A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

      - `"rooftop"`

      - `"point"`

      - `"range_interpolation"`

      - `"nearest_rooftop_match"`

      - `"intersection"`

      - `"street_center"`

      - `"place"`

      - `"state"`

    - `location: object { lat, lng }`

      Object that contains `lat`, `lng` properties with number values

      - `lat: number`

      - `lng: number`

  - `line2: optional string`

    The second line of the address.

  - `provinceOrStateName: optional string`

    The full name of the province or state.

  - `status: optional Status`

    The verification status of an address.

    - `"verified"`

    - `"corrected"`

    - `"failed"`

  - `zipPlus4: optional string`

    The zip plus 4 code of the address.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/suggestions \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "address": "address"
        }'
```

#### Response

```json
{
  "status": "success",
  "message": "Addresses suggested successfully",
  "data": [
    {
      "city": "Los Angeles",
      "country": "US",
      "line1": "1234 Elm St",
      "postalOrZip": "90001",
      "provinceOrState": "CA",
      "status": "verified",
      "errors": {}
    }
  ]
}
```

## Parse An Address

**post** `/v1/addver/parses`

Parses a freeform address string into its individual components
(house number, street name, city, state, postal code, etc.).

Useful for extracting structured data from a single-line address without
running a full verification.

- Uses 1 lookup.

### Body Parameters

- `address: string`

  The address you want to verify, written on a single line.

### Returns

- `data: object { category, city, cityDistrict, 13 more }`

  - `category: optional string`

    The category of the location (e.g. restaurant).

  - `city: optional string`

    The city name.

  - `cityDistrict: optional string`

    The borough within a city.

  - `country: optional string`

    The country.

  - `house: optional string`

    The name of the location.

  - `houseNumber: optional string`

    The house or street number.

  - `island: optional string`

    The name of the island.

  - `level: optional string`

    The floor.

  - `near: optional string`

    Populated if the input query contains a near/in qualifier.

  - `poBox: optional string`

    The postal office box.

  - `postcode: optional string`

    The postal or ZIP code.

  - `road: optional string`

    The street name.

  - `state: optional string`

    The state or province.

  - `stateDistrict: optional string`

    The county.

  - `suburb: optional string`

    The unofficial neighborhood name.

  - `unit: optional string`

    The apartment, unit, office, lot, or other secondary unit designator.

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/parses \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "address": "address"
        }'
```

#### Response

```json
{
  "data": {
    "category": "category",
    "city": "city",
    "cityDistrict": "cityDistrict",
    "country": "country",
    "house": "house",
    "houseNumber": "houseNumber",
    "island": "island",
    "level": "level",
    "near": "near",
    "poBox": "poBox",
    "postcode": "postcode",
    "road": "road",
    "state": "state",
    "stateDistrict": "stateDistrict",
    "suburb": "suburb",
    "unit": "unit"
  },
  "message": "message",
  "status": "success"
}
```

## Lookup City Or State From Postal Or Zip Code

**post** `/v1/addver/city_states`

Looks up city, county, and other location metadata for a given US or
Canadian postal code or ZIP code.

A single postal code may map to multiple cities (e.g. a ZIP that spans
several towns), so the response is an array.

- Uses 1 lookup.

### Body Parameters

- `postalOrZip: string`

### Returns

- `data: array of object { city, country, provinceOrState, 5 more }`

  - `city: string`

    The city name.

  - `country: string`

    The ISO 2-letter country code.

  - `provinceOrState: string`

    The province or state abbreviation.

  - `county: optional string`

    The county name (US addresses only).

  - `countyFIPS: optional string`

    The FIPS code for the county (US addresses only).

  - `mailable: optional boolean`

    Whether the location is mailable.

  - `preferredCity: optional string`

    The USPS preferred city name for this postal code.

  - `zipClass: optional string`

    The USPS ZIP code class (e.g. `S` for standard, `P` for PO Box only).

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/city_states \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "postalOrZip": "postalOrZip"
        }'
```

#### Response

```json
{
  "data": [
    {
      "city": "city",
      "country": "country",
      "provinceOrState": "provinceOrState",
      "county": "county",
      "countyFIPS": "countyFIPS",
      "mailable": true,
      "preferredCity": "preferredCity",
      "zipClass": "zipClass"
    }
  ],
  "message": "message",
  "status": "success"
}
```

## Lookup Zip Code From City Or State

**post** `/v1/addver/zip_codes`

Looks up all ZIP codes that correspond to a given US city and state.

- Currently only supported for US addresses (`countryCode: "US"`).
- Uses 1 lookup.

### Body Parameters

- `city: string`

  The city name.

- `countryCode: string`

  The country code. Currently only `US` is supported.

- `state: string`

  The state abbreviation (e.g. `NY`).

### Returns

- `data: object { zipCodes }`

  - `zipCodes: array of string`

- `message: string`

- `status: "success" or "error"`

  - `"success"`

  - `"error"`

### Example

```http
curl https://api.postgrid.com/v1/addver/zip_codes \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY" \
    -d '{
          "city": "city",
          "countryCode": "countryCode",
          "state": "state"
        }'
```

#### Response

```json
{
  "data": {
    "zipCodes": [
      "string"
    ]
  },
  "message": "message",
  "status": "success"
}
```

## Domain Types

### Errors

- `Errors object { city, generic, line1, 3 more }`

  Errors encountered during address verification.

  - `city: optional array of string`

    Errors related to the city.

  - `generic: optional array of string`

    Generic errors not tied to a specific field.

  - `line1: optional array of string`

    Errors related to the first address line.

  - `line2: optional array of string`

    Errors related to the second address line.

  - `postalOrZip: optional array of string`

    Errors related to the postal or ZIP code.

  - `provinceOrState: optional array of string`

    Errors related to the province or state.

### Status

- `Status = "verified" or "corrected" or "failed"`

  The verification status of an address.

  - `"verified"`

  - `"corrected"`

  - `"failed"`

### Address Verification Verify Response

- `AddressVerificationVerifyResponse object { data, message, status }`

  - `data: object { city, country, line1, 11 more }`

    - `city: string`

      The city name of the address.

    - `country: string`

      The country code of the address.

    - `line1: string`

      The first line of the address.

    - `postalOrZip: string`

      The postal code or ZIP code of the address.

    - `provinceOrState: string`

      The province or state of the address.

    - `countryName: optional string`

      The country name of the address.

    - `details: optional object { boxID, county, countyNum, 45 more }`

      If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

      - `boxID: optional string`

        PO Box ID

      - `county: optional string`

        County in the United States (US address only)

      - `countyNum: optional string`

        FIPS code for county (US address only)

      - `deliveryInstallationAreaName: optional string`

        Delivery installation area name

      - `deliveryInstallationQualifier: optional string`

        Delivery installation qualifier

      - `deliveryInstallationType: optional string`

        Delivery installation type

      - `extraInfo: optional string`

        Any extra information relevant to the address

      - `postDirection: optional string`

        The post-direction of the street (after the street name, US addresses only)

      - `preDirection: optional string`

        The pre-direction of the street (before the street name, US addresses only)

      - `residential: optional boolean`

        Indicates that the address is residential (US address only)

      - `ruralRouteNumber: optional string`

        Rural route number

      - `ruralRouteType: optional string`

        Rural route type

      - `streetDirection: optional string`

        The direction of the street (N, S, E, W, etc)

      - `streetName: optional string`

        Name of the street where the address is located

      - `streetNumber: optional string`

        Street number (e.g. the 20 in 20 Bay St)

      - `streetType: optional string`

        Type of the street (DR, ST, BLVD, etc)

      - `suiteID: optional string`

        The unit number/name

      - `suiteKey: optional string`

        The suite key

      - `usCensusBlockNumber: optional string`

        US Census block number

      - `usCensusCMSA: optional string`

        US Census consolidated metropolitan statistical area

      - `usCensusFIPS: optional string`

        US Census FIPS code (US address only)

      - `usCensusMA: optional string`

        US Census metropolitan area

      - `usCensusMSA: optional string`

        US Census metropolitan statistical area

      - `usCensusPMSA: optional string`

        US Census primary metropolitan statistical area

      - `usCensusTractNumber: optional string`

        US Census tract number

      - `usCongressionalDistrictNumber: optional string`

        US congressional district number

      - `usHasDaylightSavings: optional boolean`

        True if address location recognizes DST

      - `usMailingCheckDigit: optional string`

        PostNet barcode digit

      - `usMailingsCarrierRoute: optional string`

        4-character code assigned to mail delivery route within a 5 digit zip code

      - `usMailingsDefaultFlag: optional boolean`

        True if US address matches a high-rise default or rural route default in the USPS data

      - `usMailingsDeliveryPoint: optional string`

        Unique USPS identifier for the delivery point

      - `usMailingsDpvConfirmationIndicator: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvCrmaIndicator: optional string`

        Y if this is a commercial mail receiving agency, N otherwise

      - `usMailingsDpvFootnote1: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvFootnote2: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvFootnote3: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsElotAscDesc: optional string`

        A for ascending, D for descending

      - `usMailingsElotSequenceNumber: optional string`

        eLOT sequence number

      - `usMailingsEWSFlag: optional string`

        Y if address is in early warning system database

      - `usMailingsLACSFlag: optional string`

        Y if address converted by LACS

      - `usMailingsLACSReturnCode: optional string`

        Corresponds to USPS LACSLink return code

      - `usMailingsRecordTypeCode: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsSuiteLinkReturnCode: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usPostnetBarcode: optional string`

        PostNet barcode for the address (US address only)

      - `usStateLegislativeLower: optional string`

        Lower legislative district for the US address

      - `usStateLegislativeUpper: optional string`

        Upper legislative district for the US address

      - `usTimeZone: optional string`

        Time zone for the US address area

      - `vacant: optional boolean`

        Indicates that the address is vacant according to the USPS (US address only)

    - `errors: optional Errors`

      Errors encountered during address verification.

      - `city: optional array of string`

        Errors related to the city.

      - `generic: optional array of string`

        Generic errors not tied to a specific field.

      - `line1: optional array of string`

        Errors related to the first address line.

      - `line2: optional array of string`

        Errors related to the second address line.

      - `postalOrZip: optional array of string`

        Errors related to the postal or ZIP code.

      - `provinceOrState: optional array of string`

        Errors related to the province or state.

    - `firmName: optional string`

      The firm name of the address.

    - `geocodeResult: optional object { accuracy, accuracyType, location }`

      If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
      which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
      this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
      verification, suggestions, and POST /completions endpoint. Note that you must supply country when
      geocoding to get the result successfully.

      - `accuracy: number`

        A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

      - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

        A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

        - `"rooftop"`

        - `"point"`

        - `"range_interpolation"`

        - `"nearest_rooftop_match"`

        - `"intersection"`

        - `"street_center"`

        - `"place"`

        - `"state"`

      - `location: object { lat, lng }`

        Object that contains `lat`, `lng` properties with number values

        - `lat: number`

        - `lng: number`

    - `line2: optional string`

      The second line of the address.

    - `provinceOrStateName: optional string`

      The full name of the province or state.

    - `status: optional Status`

      The verification status of an address.

      - `"verified"`

      - `"corrected"`

      - `"failed"`

    - `zipPlus4: optional string`

      The zip plus 4 code of the address.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Get Lookup Info Response

- `AddressVerificationGetLookupInfoResponse object { data, message, status }`

  - `data: object { freeLimit, used }`

    - `freeLimit: number`

      The maximum number of lookups allowed in the current billing period.
      `null` indicates an unlimited plan.

    - `used: number`

      The number of lookups consumed in the current billing period.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Get Autocomplete Previews Response

- `AddressVerificationGetAutocompletePreviewsResponse object { data, message, status }`

  - `data: array of object { preview }`

    - `preview: object { address, city, pc, prov }`

      A partial view of the address, suitable for display in an autocomplete dropdown.

      - `address: string`

        The street address line.

      - `city: optional string`

        The city.

      - `pc: optional string`

        For US addresses, the full postal code. For non-US addresses,
        only the first 3 digits are returned to avoid consuming a lookup.

      - `prov: optional string`

        The province or state abbreviation. Returned instead of `pc` when `provInsteadOfPC=true`.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Autocomplete Response

- `AddressVerificationAutocompleteResponse object { data, message, status }`

  - `data: object { address, errors, geocodeResult }  or array of object { address, errors, geocodeResult }  or object { city, country, line1, 11 more }`

    - `CompletedAddressItem object { address, errors, geocodeResult }`

      - `address: object { address, address2, city, 3 more }`

        The resolved address components.

        - `address: string`

          The first line of the address.

        - `address2: optional string`

          The second line of the address.

        - `city: optional string`

          The city.

        - `country: optional string`

          The ISO 2-letter country code.

        - `pc: optional string`

          The postal code.

        - `prov: optional string`

          The province or state abbreviation.

      - `errors: optional Errors`

        Errors encountered during address verification.

        - `city: optional array of string`

          Errors related to the city.

        - `generic: optional array of string`

          Generic errors not tied to a specific field.

        - `line1: optional array of string`

          Errors related to the first address line.

        - `line2: optional array of string`

          Errors related to the second address line.

        - `postalOrZip: optional array of string`

          Errors related to the postal or ZIP code.

        - `provinceOrState: optional array of string`

          Errors related to the province or state.

      - `geocodeResult: optional object { accuracy, accuracyType, location }`

        Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified.

        - `accuracy: number`

          A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

        - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

          A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

          - `"rooftop"`

          - `"point"`

          - `"range_interpolation"`

          - `"nearest_rooftop_match"`

          - `"intersection"`

          - `"street_center"`

          - `"place"`

          - `"state"`

        - `location: object { lat, lng }`

          Object that contains `lat`, `lng` properties with number values

          - `lat: number`

          - `lng: number`

    - `array of object { address, errors, geocodeResult }`

      - `address: object { address, address2, city, 3 more }`

        The resolved address components.

        - `address: string`

          The first line of the address.

        - `address2: optional string`

          The second line of the address.

        - `city: optional string`

          The city.

        - `country: optional string`

          The ISO 2-letter country code.

        - `pc: optional string`

          The postal code.

        - `prov: optional string`

          The province or state abbreviation.

      - `errors: optional Errors`

        Errors encountered during address verification.

      - `geocodeResult: optional object { accuracy, accuracyType, location }`

        Geocoding result. Only present when `geocode=true` is supplied and an `index` is specified.

        - `accuracy: number`

          A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

        - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

          A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

          - `"rooftop"`

          - `"point"`

          - `"range_interpolation"`

          - `"nearest_rooftop_match"`

          - `"intersection"`

          - `"street_center"`

          - `"place"`

          - `"state"`

        - `location: object { lat, lng }`

          Object that contains `lat`, `lng` properties with number values

          - `lat: number`

          - `lng: number`

    - `StandardVerifiedAddress object { city, country, line1, 11 more }`

      - `city: string`

        The city name of the address.

      - `country: string`

        The country code of the address.

      - `line1: string`

        The first line of the address.

      - `postalOrZip: string`

        The postal code or ZIP code of the address.

      - `provinceOrState: string`

        The province or state of the address.

      - `countryName: optional string`

        The country name of the address.

      - `details: optional object { boxID, county, countyNum, 45 more }`

        If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

        - `boxID: optional string`

          PO Box ID

        - `county: optional string`

          County in the United States (US address only)

        - `countyNum: optional string`

          FIPS code for county (US address only)

        - `deliveryInstallationAreaName: optional string`

          Delivery installation area name

        - `deliveryInstallationQualifier: optional string`

          Delivery installation qualifier

        - `deliveryInstallationType: optional string`

          Delivery installation type

        - `extraInfo: optional string`

          Any extra information relevant to the address

        - `postDirection: optional string`

          The post-direction of the street (after the street name, US addresses only)

        - `preDirection: optional string`

          The pre-direction of the street (before the street name, US addresses only)

        - `residential: optional boolean`

          Indicates that the address is residential (US address only)

        - `ruralRouteNumber: optional string`

          Rural route number

        - `ruralRouteType: optional string`

          Rural route type

        - `streetDirection: optional string`

          The direction of the street (N, S, E, W, etc)

        - `streetName: optional string`

          Name of the street where the address is located

        - `streetNumber: optional string`

          Street number (e.g. the 20 in 20 Bay St)

        - `streetType: optional string`

          Type of the street (DR, ST, BLVD, etc)

        - `suiteID: optional string`

          The unit number/name

        - `suiteKey: optional string`

          The suite key

        - `usCensusBlockNumber: optional string`

          US Census block number

        - `usCensusCMSA: optional string`

          US Census consolidated metropolitan statistical area

        - `usCensusFIPS: optional string`

          US Census FIPS code (US address only)

        - `usCensusMA: optional string`

          US Census metropolitan area

        - `usCensusMSA: optional string`

          US Census metropolitan statistical area

        - `usCensusPMSA: optional string`

          US Census primary metropolitan statistical area

        - `usCensusTractNumber: optional string`

          US Census tract number

        - `usCongressionalDistrictNumber: optional string`

          US congressional district number

        - `usHasDaylightSavings: optional boolean`

          True if address location recognizes DST

        - `usMailingCheckDigit: optional string`

          PostNet barcode digit

        - `usMailingsCarrierRoute: optional string`

          4-character code assigned to mail delivery route within a 5 digit zip code

        - `usMailingsDefaultFlag: optional boolean`

          True if US address matches a high-rise default or rural route default in the USPS data

        - `usMailingsDeliveryPoint: optional string`

          Unique USPS identifier for the delivery point

        - `usMailingsDpvConfirmationIndicator: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsDpvCrmaIndicator: optional string`

          Y if this is a commercial mail receiving agency, N otherwise

        - `usMailingsDpvFootnote1: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsDpvFootnote2: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsDpvFootnote3: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsElotAscDesc: optional string`

          A for ascending, D for descending

        - `usMailingsElotSequenceNumber: optional string`

          eLOT sequence number

        - `usMailingsEWSFlag: optional string`

          Y if address is in early warning system database

        - `usMailingsLACSFlag: optional string`

          Y if address converted by LACS

        - `usMailingsLACSReturnCode: optional string`

          Corresponds to USPS LACSLink return code

        - `usMailingsRecordTypeCode: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usMailingsSuiteLinkReturnCode: optional string`

          See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

        - `usPostnetBarcode: optional string`

          PostNet barcode for the address (US address only)

        - `usStateLegislativeLower: optional string`

          Lower legislative district for the US address

        - `usStateLegislativeUpper: optional string`

          Upper legislative district for the US address

        - `usTimeZone: optional string`

          Time zone for the US address area

        - `vacant: optional boolean`

          Indicates that the address is vacant according to the USPS (US address only)

      - `errors: optional Errors`

        Errors encountered during address verification.

      - `firmName: optional string`

        The firm name of the address.

      - `geocodeResult: optional object { accuracy, accuracyType, location }`

        If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
        which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
        this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
        verification, suggestions, and POST /completions endpoint. Note that you must supply country when
        geocoding to get the result successfully.

        - `accuracy: number`

          A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

        - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

          A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

          - `"rooftop"`

          - `"point"`

          - `"range_interpolation"`

          - `"nearest_rooftop_match"`

          - `"intersection"`

          - `"street_center"`

          - `"place"`

          - `"state"`

        - `location: object { lat, lng }`

          Object that contains `lat`, `lng` properties with number values

          - `lat: number`

          - `lng: number`

      - `line2: optional string`

        The second line of the address.

      - `provinceOrStateName: optional string`

        The full name of the province or state.

      - `status: optional Status`

        The verification status of an address.

        - `"verified"`

        - `"corrected"`

        - `"failed"`

      - `zipPlus4: optional string`

        The zip plus 4 code of the address.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Batch Verification Response

- `AddressVerificationBatchVerificationResponse object { data, message, status }`

  - `data: object { results }`

    - `results: array of object { error, verifiedAddress }`

      - `error: optional string`

        An error message for this address. Present when verification failed.

      - `verifiedAddress: optional object { city, country, line1, 11 more }`

        The verified address result. Present when verification succeeded.

        - `city: string`

          The city name of the address.

        - `country: string`

          The country code of the address.

        - `line1: string`

          The first line of the address.

        - `postalOrZip: string`

          The postal code or ZIP code of the address.

        - `provinceOrState: string`

          The province or state of the address.

        - `countryName: optional string`

          The country name of the address.

        - `details: optional object { boxID, county, countyNum, 45 more }`

          If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

          - `boxID: optional string`

            PO Box ID

          - `county: optional string`

            County in the United States (US address only)

          - `countyNum: optional string`

            FIPS code for county (US address only)

          - `deliveryInstallationAreaName: optional string`

            Delivery installation area name

          - `deliveryInstallationQualifier: optional string`

            Delivery installation qualifier

          - `deliveryInstallationType: optional string`

            Delivery installation type

          - `extraInfo: optional string`

            Any extra information relevant to the address

          - `postDirection: optional string`

            The post-direction of the street (after the street name, US addresses only)

          - `preDirection: optional string`

            The pre-direction of the street (before the street name, US addresses only)

          - `residential: optional boolean`

            Indicates that the address is residential (US address only)

          - `ruralRouteNumber: optional string`

            Rural route number

          - `ruralRouteType: optional string`

            Rural route type

          - `streetDirection: optional string`

            The direction of the street (N, S, E, W, etc)

          - `streetName: optional string`

            Name of the street where the address is located

          - `streetNumber: optional string`

            Street number (e.g. the 20 in 20 Bay St)

          - `streetType: optional string`

            Type of the street (DR, ST, BLVD, etc)

          - `suiteID: optional string`

            The unit number/name

          - `suiteKey: optional string`

            The suite key

          - `usCensusBlockNumber: optional string`

            US Census block number

          - `usCensusCMSA: optional string`

            US Census consolidated metropolitan statistical area

          - `usCensusFIPS: optional string`

            US Census FIPS code (US address only)

          - `usCensusMA: optional string`

            US Census metropolitan area

          - `usCensusMSA: optional string`

            US Census metropolitan statistical area

          - `usCensusPMSA: optional string`

            US Census primary metropolitan statistical area

          - `usCensusTractNumber: optional string`

            US Census tract number

          - `usCongressionalDistrictNumber: optional string`

            US congressional district number

          - `usHasDaylightSavings: optional boolean`

            True if address location recognizes DST

          - `usMailingCheckDigit: optional string`

            PostNet barcode digit

          - `usMailingsCarrierRoute: optional string`

            4-character code assigned to mail delivery route within a 5 digit zip code

          - `usMailingsDefaultFlag: optional boolean`

            True if US address matches a high-rise default or rural route default in the USPS data

          - `usMailingsDeliveryPoint: optional string`

            Unique USPS identifier for the delivery point

          - `usMailingsDpvConfirmationIndicator: optional string`

            See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

          - `usMailingsDpvCrmaIndicator: optional string`

            Y if this is a commercial mail receiving agency, N otherwise

          - `usMailingsDpvFootnote1: optional string`

            See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

          - `usMailingsDpvFootnote2: optional string`

            See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

          - `usMailingsDpvFootnote3: optional string`

            See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

          - `usMailingsElotAscDesc: optional string`

            A for ascending, D for descending

          - `usMailingsElotSequenceNumber: optional string`

            eLOT sequence number

          - `usMailingsEWSFlag: optional string`

            Y if address is in early warning system database

          - `usMailingsLACSFlag: optional string`

            Y if address converted by LACS

          - `usMailingsLACSReturnCode: optional string`

            Corresponds to USPS LACSLink return code

          - `usMailingsRecordTypeCode: optional string`

            See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

          - `usMailingsSuiteLinkReturnCode: optional string`

            See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

          - `usPostnetBarcode: optional string`

            PostNet barcode for the address (US address only)

          - `usStateLegislativeLower: optional string`

            Lower legislative district for the US address

          - `usStateLegislativeUpper: optional string`

            Upper legislative district for the US address

          - `usTimeZone: optional string`

            Time zone for the US address area

          - `vacant: optional boolean`

            Indicates that the address is vacant according to the USPS (US address only)

        - `errors: optional Errors`

          Errors encountered during address verification.

          - `city: optional array of string`

            Errors related to the city.

          - `generic: optional array of string`

            Generic errors not tied to a specific field.

          - `line1: optional array of string`

            Errors related to the first address line.

          - `line2: optional array of string`

            Errors related to the second address line.

          - `postalOrZip: optional array of string`

            Errors related to the postal or ZIP code.

          - `provinceOrState: optional array of string`

            Errors related to the province or state.

        - `firmName: optional string`

          The firm name of the address.

        - `geocodeResult: optional object { accuracy, accuracyType, location }`

          If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
          which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
          this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
          verification, suggestions, and POST /completions endpoint. Note that you must supply country when
          geocoding to get the result successfully.

          - `accuracy: number`

            A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

          - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

            A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

            - `"rooftop"`

            - `"point"`

            - `"range_interpolation"`

            - `"nearest_rooftop_match"`

            - `"intersection"`

            - `"street_center"`

            - `"place"`

            - `"state"`

          - `location: object { lat, lng }`

            Object that contains `lat`, `lng` properties with number values

            - `lat: number`

            - `lng: number`

        - `line2: optional string`

          The second line of the address.

        - `provinceOrStateName: optional string`

          The full name of the province or state.

        - `status: optional Status`

          The verification status of an address.

          - `"verified"`

          - `"corrected"`

          - `"failed"`

        - `zipPlus4: optional string`

          The zip plus 4 code of the address.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Suggest Addresses Response

- `AddressVerificationSuggestAddressesResponse object { data, message, status }`

  - `data: array of object { city, country, line1, 11 more }`

    - `city: string`

      The city name of the address.

    - `country: string`

      The country code of the address.

    - `line1: string`

      The first line of the address.

    - `postalOrZip: string`

      The postal code or ZIP code of the address.

    - `provinceOrState: string`

      The province or state of the address.

    - `countryName: optional string`

      The country name of the address.

    - `details: optional object { boxID, county, countyNum, 45 more }`

      If you supply `includeDetails=true` as a query parameter, we will also populate an additional `details` field that follows the [Address Details](https://avdocs.postgrid.com/#address-details) schema.

      - `boxID: optional string`

        PO Box ID

      - `county: optional string`

        County in the United States (US address only)

      - `countyNum: optional string`

        FIPS code for county (US address only)

      - `deliveryInstallationAreaName: optional string`

        Delivery installation area name

      - `deliveryInstallationQualifier: optional string`

        Delivery installation qualifier

      - `deliveryInstallationType: optional string`

        Delivery installation type

      - `extraInfo: optional string`

        Any extra information relevant to the address

      - `postDirection: optional string`

        The post-direction of the street (after the street name, US addresses only)

      - `preDirection: optional string`

        The pre-direction of the street (before the street name, US addresses only)

      - `residential: optional boolean`

        Indicates that the address is residential (US address only)

      - `ruralRouteNumber: optional string`

        Rural route number

      - `ruralRouteType: optional string`

        Rural route type

      - `streetDirection: optional string`

        The direction of the street (N, S, E, W, etc)

      - `streetName: optional string`

        Name of the street where the address is located

      - `streetNumber: optional string`

        Street number (e.g. the 20 in 20 Bay St)

      - `streetType: optional string`

        Type of the street (DR, ST, BLVD, etc)

      - `suiteID: optional string`

        The unit number/name

      - `suiteKey: optional string`

        The suite key

      - `usCensusBlockNumber: optional string`

        US Census block number

      - `usCensusCMSA: optional string`

        US Census consolidated metropolitan statistical area

      - `usCensusFIPS: optional string`

        US Census FIPS code (US address only)

      - `usCensusMA: optional string`

        US Census metropolitan area

      - `usCensusMSA: optional string`

        US Census metropolitan statistical area

      - `usCensusPMSA: optional string`

        US Census primary metropolitan statistical area

      - `usCensusTractNumber: optional string`

        US Census tract number

      - `usCongressionalDistrictNumber: optional string`

        US congressional district number

      - `usHasDaylightSavings: optional boolean`

        True if address location recognizes DST

      - `usMailingCheckDigit: optional string`

        PostNet barcode digit

      - `usMailingsCarrierRoute: optional string`

        4-character code assigned to mail delivery route within a 5 digit zip code

      - `usMailingsDefaultFlag: optional boolean`

        True if US address matches a high-rise default or rural route default in the USPS data

      - `usMailingsDeliveryPoint: optional string`

        Unique USPS identifier for the delivery point

      - `usMailingsDpvConfirmationIndicator: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvCrmaIndicator: optional string`

        Y if this is a commercial mail receiving agency, N otherwise

      - `usMailingsDpvFootnote1: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvFootnote2: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsDpvFootnote3: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsElotAscDesc: optional string`

        A for ascending, D for descending

      - `usMailingsElotSequenceNumber: optional string`

        eLOT sequence number

      - `usMailingsEWSFlag: optional string`

        Y if address is in early warning system database

      - `usMailingsLACSFlag: optional string`

        Y if address converted by LACS

      - `usMailingsLACSReturnCode: optional string`

        Corresponds to USPS LACSLink return code

      - `usMailingsRecordTypeCode: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usMailingsSuiteLinkReturnCode: optional string`

        See [USPS DPV](https://avdocs.postgrid.com/#usps-dpv)

      - `usPostnetBarcode: optional string`

        PostNet barcode for the address (US address only)

      - `usStateLegislativeLower: optional string`

        Lower legislative district for the US address

      - `usStateLegislativeUpper: optional string`

        Upper legislative district for the US address

      - `usTimeZone: optional string`

        Time zone for the US address area

      - `vacant: optional boolean`

        Indicates that the address is vacant according to the USPS (US address only)

    - `errors: optional Errors`

      Errors encountered during address verification.

      - `city: optional array of string`

        Errors related to the city.

      - `generic: optional array of string`

        Generic errors not tied to a specific field.

      - `line1: optional array of string`

        Errors related to the first address line.

      - `line2: optional array of string`

        Errors related to the second address line.

      - `postalOrZip: optional array of string`

        Errors related to the postal or ZIP code.

      - `provinceOrState: optional array of string`

        Errors related to the province or state.

    - `firmName: optional string`

      The firm name of the address.

    - `geocodeResult: optional object { accuracy, accuracyType, location }`

      If the `geocode=true` query parameter is supplied, the response will include a geocodeResult
      which follows the [Geocoding](https://avdocs.postgrid.com/#geocoding) schema.  You can request
      this feature be enabled by emailing `support@postgrid.com`. This includes our verification, batch
      verification, suggestions, and POST /completions endpoint. Note that you must supply country when
      geocoding to get the result successfully.

      - `accuracy: number`

        A real number from 0.00 to 1.00 which represents an [accuracy score](https://avdocs.postgrid.com/#accuracy-score)

      - `accuracyType: "rooftop" or "point" or "range_interpolation" or 5 more`

        A string representing the [accuracy type](https://avdocs.postgrid.com/#accuracy-type)

        - `"rooftop"`

        - `"point"`

        - `"range_interpolation"`

        - `"nearest_rooftop_match"`

        - `"intersection"`

        - `"street_center"`

        - `"place"`

        - `"state"`

      - `location: object { lat, lng }`

        Object that contains `lat`, `lng` properties with number values

        - `lat: number`

        - `lng: number`

    - `line2: optional string`

      The second line of the address.

    - `provinceOrStateName: optional string`

      The full name of the province or state.

    - `status: optional Status`

      The verification status of an address.

      - `"verified"`

      - `"corrected"`

      - `"failed"`

    - `zipPlus4: optional string`

      The zip plus 4 code of the address.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Parse An Address Response

- `AddressVerificationParseAnAddressResponse object { data, message, status }`

  - `data: object { category, city, cityDistrict, 13 more }`

    - `category: optional string`

      The category of the location (e.g. restaurant).

    - `city: optional string`

      The city name.

    - `cityDistrict: optional string`

      The borough within a city.

    - `country: optional string`

      The country.

    - `house: optional string`

      The name of the location.

    - `houseNumber: optional string`

      The house or street number.

    - `island: optional string`

      The name of the island.

    - `level: optional string`

      The floor.

    - `near: optional string`

      Populated if the input query contains a near/in qualifier.

    - `poBox: optional string`

      The postal office box.

    - `postcode: optional string`

      The postal or ZIP code.

    - `road: optional string`

      The street name.

    - `state: optional string`

      The state or province.

    - `stateDistrict: optional string`

      The county.

    - `suburb: optional string`

      The unofficial neighborhood name.

    - `unit: optional string`

      The apartment, unit, office, lot, or other secondary unit designator.

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Lookup City Or State From Postal Or Zip Code Response

- `AddressVerificationLookupCityOrStateFromPostalOrZipCodeResponse object { data, message, status }`

  - `data: array of object { city, country, provinceOrState, 5 more }`

    - `city: string`

      The city name.

    - `country: string`

      The ISO 2-letter country code.

    - `provinceOrState: string`

      The province or state abbreviation.

    - `county: optional string`

      The county name (US addresses only).

    - `countyFIPS: optional string`

      The FIPS code for the county (US addresses only).

    - `mailable: optional boolean`

      Whether the location is mailable.

    - `preferredCity: optional string`

      The USPS preferred city name for this postal code.

    - `zipClass: optional string`

      The USPS ZIP code class (e.g. `S` for standard, `P` for PO Box only).

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`

### Address Verification Lookup Zip Code From City Or State Response

- `AddressVerificationLookupZipCodeFromCityOrStateResponse object { data, message, status }`

  - `data: object { zipCodes }`

    - `zipCodes: array of string`

  - `message: string`

  - `status: "success" or "error"`

    - `"success"`

    - `"error"`