Determine if an address is a valid mailing address
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
address
object
required
If requested, this is address candidate most closely matches the requested address
addressobject
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
truefalse
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
truefalse
includeCandidate
boolean
Include an address candidate in the response if one is found
truetruefalse
Response Codes
``200 Address validation response
``403 Not authenticated / authorized via OAuth
Updated 28 days ago
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
200403