This operation provides address fragments based on validated address inputs.
URL Endpoints
ParseCanadianAddress Inputs
Name | Type | Description |
---|---|---|
Address | String | Address line of the address to parse. For example, “123 Main Street”. |
Address 2 | String | The Address2 of the address to parse. 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 parse. |
Province | String | The Province of the address to parse. |
PostalCode | String | The Postal Code of the address to parse. 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/ |
ParseCanadianAddress 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 parsed Address line. |
Address 2 | String | Varies | The parsed Address 2 line. |
Municipality | String | Varies | The parsed Municipality |
Province | String | Varies | The corrected Province. |
PostalCode | String | Varies | The parsed PostalCode. |
TimeZone | String | Varies | No Result |
AddressNumberFragment | String | Varies | The parsed Address Number Fragment. “123” of “123 S. Main Street” |
StreetNameFragment | String | Varies | The parsed Street Name Fragment “Main” of “123 S. Main Street” |
StreetTypeFragment | String | Varies | The parsed Street Type Fragment. “Street” of “123 S. Main Street” |
DirectionalCodeFragment | String | Varies | The parsed Directional Code Fragment. “South” of “123 S. Main Street” |
UnitTypeFragment | String | Varies | The parsed Unit Type Fragment. “Apt” or “Suite” etc |
UnitNumberFragment | String | Varies | The parsed Unit Number Fragment. “1” of “Apt. 1” |
IsPOBox | String | Varies | No Result. |
BoxNumberFragment | String | Varies | The parsed Box Number Fragment. |
StationInfo | String | Varies | No Result. |
DeliveryMode | String | Varies | No Result. |
DeliveryInstallation | String | Varies | No Result. |