Determine if an address is a valid mailing address

URL Expired

The URL for this request expired after 30 days.

Address Validation Parameters

• address: If requested, this is the address candidate that most closely matches the requested 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 Codes

• 200: Address validation response
• 403: Not authenticated / authorized via OAuth

Example Request

curl --request POST \
     --url https://api.shipium.com/api/v1/address/validate \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

• application/json
• 200
• 403