apyhub-logo
CatalogPricingBlog
Log in

Validate UK Postcodes

Data Validation#postcodes#uk
1 atom
Base tier

About

The UK Postal Code validation service can be used to validate postcodes within UK.
Postcode is used by delivery services to do delivery route planning and to provide recommendations based on your users' area among other scenarios. In such cases, validating postcodes when collecting them from users ensures that you can alert them in case of mistakes and collect only valid addresses. This can help reduce the cost of returned or undeliverable mail. By ensuring that addresses are accurate and complete, organizations can reduce the need for manual processing and re-delivery.

API Playground

Documentation

validate
POST
https://api.apyhub.com/validate/postcodes/uk

Request example

1
curl --location --request POST 'https://api.apyhub.com/validate/postcodes/uk' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data-raw '{
5
    "postcode":"AB11 5QN"
6
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
postcodeStringYesThe postal code that you want to validate.
Response
AttributeTypeDescription
dataBooleanA boolean value indicating whether the postcode is valid or not
Sample Response
A successful request returns true or false based on if the postcode is valid or not in a JSON format. If the request fails, the response contains an error code and a message to help determine what went wrong.
1
{
2
    "data": true
3
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the postcode is missing
500If any unexpected error occurs while processing the request

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.