Checks if a postcode is valid.
To connect to this service you'll need to use one of these endpoints:
The service will attempt to validate the supplied postcode. The postcode can be supplied in any format, so
CH2 4NE and
ch24ne will both be accepted. If the postcode is valid, a version of the same postcode with standardised formatting will be returned.
Whether or not the supplied postcode is valid, a list of possible alternative postcodes will also be returned. These will be postcodes that could be possible mistypings of the supplied postcode and could be offered to the user as suggested corrections, especially when the supplied postcode is flagged as invalid.
The following parameters can be supplied to this method
The postcode to verify
The following options can be specified as part of the
option parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
ApplicationNameGives the name of the calling application - used to break down usage by application in the usage reports on the dashboard
This method returns an object containing the following fields:
Success field is
true, the other results described below can be used to get the results of the method.
false, some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the
ErrorMessage field, and any other results should be ignored
Indicates if the supplied
A list of other valid postcodes which are potential mistypings of the supplied