Authentication

All requests to the API are over the HTTPS protocol, and you will be using HTTP Basic Authentication to pass your credentials. You create authentication credentials (API keys) using the API Keys page in your account. For more details on how to implement the correct authentication code, please see our code samples.

Creating Your Own API Keys

You can use the account section of the website to generate as many API keys as you require. Simply login and go to your account using the link in the top right corner of the website, and click on "API Keys" from the account menu.

Please bear in mind that for security reasons no-one (including StreetCheck personnel) has access to your API passwords, so you must ensure that you keep these safe as we will not be able to retrieve them should you forget them.

Using the API Keys

For more details on how to implement the correct authentication code, please see our code samples.

Sandbox vs. Live API

Using the API Keys page in your account, you may create either Sandbox or Live API keys. The basic differences are:

  • Live keys give access to ALL postcodes on the website, whereas Sandbox keys only allow you to access postcodes which are in the SN5 postcode district.
  • You must pay for every call made when using a Live key, whereas calls made using Sandbox keys are free.

Regardless of the type of key used, the API URLs remain the same. Sandbox key are useful when first building your application, or for testing out changes, but for a fully complete application, a Live key would be needed. Please also note that our terms and conditions specifically prohibit the use of Sandbox keys for the purpose of avoiding payment.

A full list of the postcodes beginning with SN5, which can be used during sandbox testing can be found here, or you may retrieve the list via the API (see the searching endpoint).