Skip to the content

IsValid

Checks if a postcode is valid.

Live Demo

To connect to this service you'll need to use one of these endpoints:

WSDL
https://webservices.data-8.co.uk/postcodeverify.asmx
JSON
https://webservices.data-8.co.uk/PostcodeVerify/IsValid.json

Description

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.

Parameters

The following parameters can be supplied to this method

username

username

See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix apikey-, e.g. apikey-ABCD-1234-EFGH-5678
password

password

If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
postcode

postcode

The postcode to verify

Advanced Options

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.

Common Options
Name Description
ApplicationName

ApplicationName

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard

Results

This method returns an object containing the following fields:

Status

Status

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is 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
ValidPostcode

ValidPostcode

Indicates if the supplied postcode is valid

FormattedPostcode

FormattedPostcode

The supplied postcode changed to a standardised format

AlternativePostcodes

AlternativePostcodes

A list of other valid postcodes which are potential mistypings of the supplied postcode.

Live Demo

postcode
options
Name Value
Common Options

Sample Code

Start a Free 14 Day Trial Today

Register below to start a free trial of our services