Skip to navigation

Validate Address Information

View as Markdown
Validate city, address, and street number information in a single request.

Request

This endpoint expects an object.
citystringRequired
The city name to validate
addressstringRequired
The address or street name to validate
numberstringRequired
The street number to validate
provincestringRequired
The province name or abbreviation to validate

Response

Address validation completed successfully.
cityobject
addressobject
streetNumberstring
The validated street number
egonCodestring
The EGON code identifier for the street number
validCityboolean
Whether the city is valid
validAddressboolean
Whether the address is valid
validStreetNumberboolean
Whether the street number is valid
validboolean

Overall validity indicator (true if all validations pass)

Errors

400
Bad Request Error
500
Internal Server Error