This operation performs basic checks on user-supplied inputs; Municipality, Province, or Postal Code and returns verified Municipality, Province, and Postal Code. This operation also returns the time zone and a check 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

  • XML:
    • https://trial.serviceobjects.com/AVCA2/api.svc/ValidateCanadianMunicipalityProvince?PostalCode={POSTALCODE}&Province={PROVINCE}&Municipality={MUNICIPALITY}&LicenseKey={LICENSEKEY}
  • JSON:
    • https://trial.serviceobjects.com/AVCA2/api.svc/ValidateCanadianMunicipalityProvince?PostalCode={POSTALCODE}&Province={PROVINCE}&Municipality={MUNICIPALITY}&format=json&LicenseKey={LICENSEKEY}

Run This Request in Postman

Test with this jurisdiction:
BOWEN ISLAND BC V0N 1G2

Check out the Integration Code in GitHub

GitHub

ValidateCanadianMunicipalityProvince Inputs

Name Type Description
Municipality String Municipality to validate.
Postal Code String The Postal Code to validate, which can be supplied instead of Municipality and Province to provide validated Municipality and Province.
Province String The Province to validate.
LicenseKey String Your license key to use the service. Sign up for a free trial key at https://www.serviceobjects.com/address-validation/

ValidateCanadianMunicipalityProvince 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 No Result.
Address 2 String Varies No Result.
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 municipality province.
AddressNumberFragment String Varies No Result.
StreetNameFragment String Varies No Result.
StreetTypeFragment String Varies No Result.
DirectionalCodeFragment String Varies No Result.
UnitTypeFragment String Varies No Result.
UnitNumberFragment String Varies No Result.
IsPOBox String Varies The returned Boolean value of a validated address as being a PO Box address.
BoxNumberFragment String Varies No Result.
StationInfo String Varies No Result.
DeliveryMode String Varies The returned Delivery Mode of the Delivery Station.
DeliveryInstallation String Varies The returned Delivery Installation Type is where the final mail sort happens.

References