Sign in

v1

latestOpenAPI 3.0.12026-07-2481208369.3 KB
address-validation

Determine if an address is a valid mailing address

post/api/v1/address/validate

Request body

ignoreSecondaryAddressMismatchboolean

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

useSimplifiedCarrierValidationboolean

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

includeCandidateboolean

Include an address candidate in the response if one is found

Example request

{
  "address": {
    "street1": "123 MAIN ST",
    "street2": "STE 42",
    "city": "ALBUQUERQUE",
    "region": "NM",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87111",
    "addressType": "commercial"
  },
  "includeCandidate": true
}

Response

Address validation response

addressValidationIdstring required

A shipium generated id that uniquely identifies this request

validboolean required

True here indicates the requested address is valid

ignoreSecondaryAddressMismatchboolean

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

useSimplifiedCarrierValidationboolean

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

Example response

{
  "address": {
    "street1": "123 MAIN ST",
    "street2": "STE 42",
    "city": "ALBUQUERQUE",
    "region": "NM",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87111",
    "addressType": "commercial"
  },
  "addressProperties": {
    "poBox": true,
    "poBoxType": "PO_BOX",
    "militaryAddressType": "APO"
  },
  "candidate": {
    "street1": "123 MAIN ST",
    "street2": "STE 42",
    "city": "ALBUQUERQUE",
    "region": "NM",
    "state": "NM",
    "countryCode": "US",
    "postalCode": "87111",
    "addressType": "commercial"
  },
  "details": [
    {
      "errorCode": "MISMATCH_REGION_AND_POSTAL",
      "errorDescription": "MISMATCH_REGION_AND_POSTAL"
    }
  ]
}