API Reference

Determine if an address is a valid mailing address

post
https://api.shipium.com/api/v1/address/validate
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
address
object
required

If requested, this is address candidate most closely matches the requested address

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

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

boolean

Include an address candidate in the response if one is found

Responses

Updated 6 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago