This operation performs basic checks on user-supplied inputs; Address1, Address2, Municipality, Province or Postal Code and returns verified Address, Municipality, Province, and Postal Code in Canadian address recommended format which is uppercased. This operation also returns the time zone and checks on if the supplied location is a P.O. Box, General Delivery, or Rural Route. This operation requires either a Postal Code or both Municipality and Province. Providing all inputs is recommended because it helps the validation proceed if some of the elements are malformed.

 

URL Endpoints 

 

ValidateCanadianAddress Inputs 

Name Type Description
Address String Address line of the address to validate.
For example, “123 Main Street”.
Address 2 String The Address2 of the address to validate. This will only be used in particular situations where the Address1 does not help in validating the address.
Municipality String The Municipality of the address to validate.
Province String The Province of the address to validate.
PostalCode String The Postal Code of the address to validate. A Postal Code isn’t required, but if one is not provided, the Municipality and Province are required.
LicenseKey String Your license key to use the service.
Sign up for a free trial key at
https://www.serviceobjects.com/address-validation/

ValidateCanadianAddress Outputs 

  • CanadianAddressResponse
Name Type Values Description
CanadianAddressInfo Object Varies The returned values of a valid Canadian Address.
Error Object Varies The returned error result from a failed address verification or user input error.
Debug String[] Varies Used internally for testing.
  • CanadianAddressInfo
Name Type Values Description
Address String Varies The corrected Address line 1.
Address 2 String Varies The corrected Address line 2.
Municipality String Varies The corrected Municipality.
Province String Varies The corrected Province.
PostalCode String Varies The corrected PostalCode.
TimeZone String Varies The corresponding time zone from the validated address.
AddressNumberFragment String Varies The parsed address number returned from the validated address.
“123” in “123 S. Main Street”
StreetNameFragment String Varies The parsed street name fragment returned from the validated address.
“Main” in “123 S. Main Street”
StreetTypeFragment String Varies The parsed street type returned from the validated address.
“Street” in “123 S. Main Street”
DirectionalCodeFragment String Varies The parsed returned directional code fragment from the validated address.
“S” in “123 S. Main Street”
UnitTypeFragment String Varies The parsed unit type fragment from the validated address. i.e. “Apt” or “Suite”
UnitNumberFragment String Varies The parsed unit number fragment from the validated address. “1” of “Apt 1”
IsPOBox String Varies The returned Boolean value of a validated address as being a PO Box address.
BoxNumberFragment String Varies The returned Box Number from a PO Box address.
StationInfo String Varies The returned Station Name of the Delivery Station.
DeliveryMode String Varies The returned Delivery Mode of the address.
DeliveryInstallation String Varies The returned Delivery Installation Type where the final mail sort happens.

References