Troubleshooting
We've created this page to help you resolve common issues but contact us if you need any help.
Check HTTP status codes
Postcoder responds to each request with one of several HTTP status codes shown below. We recommend your check the status within your integration and handle it accordingly. Note, an HTTP status code of 200 indicates a request was successful but does not imply that results - such as addresses - were found.
| HTTP status code | Description |
|---|---|
| 200 | The request was successful |
| 400 | An issue with the contents of the request (e.g. a required parameter is missing) |
| 403 | An issue with the API key or account (e.g. the API key is invalid or there are insufficient credits for the request) |
| 404 | An issue with the structure of the request (e.g. the endpoint does not exist) |
| 500 | An issue with Postcoder, which we will likely already be working to resolve |
Check credits remaining with an API call
Use the status or status/creditsabovethreshold endpoints to programmatically check how many credits remain on your API key. Alternatively, go to the Credit pack management page to see the same information.
Segment usage on your API key
When using your API key on different pages of your website or app, you may wish to know how many requests each page has made. You can determine this by setting the identifier parameter of each request to a meaningful value such as "SignupForm" or "CheckoutPage". You can then view these identifiers and the number of requests made using each one on the Identifier Usage page.
https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/...?identifier=SignupForm https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/...?identifier=CheckoutPageUse Postcoder with other organisations
When using Postcoder in solutions that you provide, sell or licence to other organisations, you must provide the name and registered address of each organisation, and identify your requests so that Postcoder knows which organisation is making each request. This information is used to return the correct licence fees to Royal Mail and other data suppliers used by Postcoder, and you can choose how to provide it:
Option 1: Use identifiers
Make requests using your API key and a different identifier parameter for each organisation.
All requests consume credits from the same credit pack or monthly plan.
View usage by identifier using the Identifier Usage page.
Step a: Choose your own identifiers and use them in your requests like this:
https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/...?identifier=JohnLewis https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/...?identifier=NextStep b: Attach an organisation name and address to each identifier using the Identifiers page.
Option 2: Upgrade to a partner account and create client accounts
Make requests using a different client account and API key for each organisation.
Client accounts consume credits from the credit pack or monthly plan that you choose.
Contact Sales to upgrade your account
View recently recorded errors
Go to the Error reports page to view recently recorded errors from requests made using your API key.
Resolve 403 errors
Here's how to resolve some 403 errors that you may encounter during integration:
Browser direct lookups exceeded, retry later
This means you've exceeded the default rate limit of 5 requests from any one IP address in 5 minutes. Manage the security settings for your API key to increase the limit, and review the API key security page to ensure you have the optimum security settings in place.
The server IP address is not registered
This indicates a request was made from an IP address that is not on your trusted IP address list. Manage the security settings for your API key to add the IP address or IP address range, and review the API key security page to ensure you have the optimum security settings in place.
Account doesn't have access to required datasets
This error occurs when your API key is used to make a request for a dataset or feature that is not currently enabled on your API key. Some datasets such as Eircode and AddressBase and features like email and mobile validation need to be enabled before they can be used. Visit the Features page to enable access.
Configure your firewall and security layers
You can allow Postcoder through your firewall and security layers by allow-listing the domain of ws.postcoder.com.
We do not recommed allow-listing by IP address since Postcoder is load-balanced across multiple IP addresses which change frequently.
Reset your lost password
Go to the Reset password page to update your password if you've forgotten it.
Change your email address
Go to your User profile to change your email address if you're still able to log into your account.
Contact us if you've forgotten the email address associated with your account, or if you no longer have access to it.
Please understand that we will need to verify your identity and details to ensure you are the rightful owner before any changes can be made.