---
title: "Determine if an address is a valid mailing address"
method: POST
path: "/api/v1/address/validate"
tags: ["address-validation"]
---

# Determine if an address is a valid mailing address

`POST /api/v1/address/validate`

## Request body

- AddressValidationRequest
  - `address` ASAddress, required — If requested, this is address candidate most closely matches the requested address
    - `street1` string — The first address line.
    - `street2` string — The second address line.
    - `city` string — The name of the city for the address.
    - `region` string — The name of the state or region for the address. Only one state or region field can be present in the request
    - `state` string — The name of the state or region for the address. Only one state or region field can be present in the request
    - `countryCode` string — The ISO 3166-1 country code for the address.
    - `postalCode` string — The postal code for the address
    - `addressType` 'commercial' | 'residential' — The type of location for this address.
  - `ignoreSecondaryAddressMismatch` boolean — When true, the system will match only the primary address portions of the address line with the candidate VALIDATED: postalCode, state/region, primaryAddressNumber, preDirectional, streetName, streetSuffix, and postDirectional. DID NOT VALIDATE: secondaryAddress, secondaryAddressIdentifier, or extraInformation
  - `useSimplifiedCarrierValidation` boolean — When true, instructs the system to ignore matching the street address with the candidate. VALIDATED: postalCode, state/region, addressType DID NOT VALIDATE: primaryAddressNumber, preDirectional, streetName, streetSuffix, and postDirectional. secondaryAddress, secondaryAddressIdentifier, or extraInformation
  - `includeCandidate` boolean — Include an address candidate in the response if one is found

## Response `200`

Address validation response

- AddressValidationResponse
  - `addressValidationId` string, required — A shipium generated id that uniquely identifies this request
  - `address` ASAddress, required — If requested, this is address candidate most closely matches the requested address
    - `street1` string — The first address line.
    - `street2` string — The second address line.
    - `city` string — The name of the city for the address.
    - `region` string — The name of the state or region for the address. Only one state or region field can be present in the request
    - `state` string — The name of the state or region for the address. Only one state or region field can be present in the request
    - `countryCode` string — The ISO 3166-1 country code for the address.
    - `postalCode` string — The postal code for the address
    - `addressType` 'commercial' | 'residential' — The type of location for this address.
  - `valid` boolean, required — True here indicates the requested address is valid
  - `ignoreSecondaryAddressMismatch` boolean — Indicates whether the system validated the main parts of the addressLine against the candidate. VALIDATED: postalCode, state/region, primaryAddressNumber, preDirectional, streetName, streetSuffix, and postDirectional. DID NOT VALIDATE: secondaryAddress, secondaryAddressIdentifier, or extraInformation
  - `useSimplifiedCarrierValidation` boolean — Indicates whether the system matched the street address with the candidate. VALIDATED: postalCode, state/region, addressType, DID NOT VALIDATE: primaryAddressNumber, preDirectional, streetName, streetSuffix, and postDirectional. secondaryAddress, secondaryAddressIdentifier, or extraInformation
  - `addressProperties` AddressProperties — Includes additional information related to the address
    - `poBox` boolean — An indicator for the address being a US Post Office Box
    - `poBoxType` 'RR' | 'HC' | 'PO_BOX' — PO box classification type: PO_BOX, HC (Highway Contract Route), or RR (Rural Route)
    - `militaryAddressType` 'APO' | 'FPO' | 'DPO' — Military address type: APO (Army Post Office), FPO (Fleet Post Office), or DPO (Diplomatic Post Office)
  - `candidate` ASAddress — If requested, this is address candidate most closely matches the requested address
    - `street1` string — The first address line.
    - `street2` string — The second address line.
    - `city` string — The name of the city for the address.
    - `region` string — The name of the state or region for the address. Only one state or region field can be present in the request
    - `state` string — The name of the state or region for the address. Only one state or region field can be present in the request
    - `countryCode` string — The ISO 3166-1 country code for the address.
    - `postalCode` string — The postal code for the address
    - `addressType` 'commercial' | 'residential' — The type of location for this address.
  - `details` ResponseDetail[] — details about the validation result
    - `errorCode` string — The code for this type of error
    - `errorDescription` string — Additional detail about the error

## Other responses

- `403` — Not authenticated / authorized via OAuth

---

[API](https://skmtc.net/shipium/apis/shipium-api.md) · [All operations](https://skmtc.net/shipium/apis/shipium-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipium/shipium-api/revisions/7ef5dbd6a025/schema)