Postcode Lookup
Increase completion rates, reduce errors and improve user experience when entering address details.
The Postcode Address File (PAF) contains accurate, up-to-date information on over 29 million UK residential and business addresses, and is a simple low cost improvement for your website or software application.
Save time, improve accuracy and ensure your solutions deliver a better experience for users with this easy to integrate endpoint.
Key Features
29m+ Addresses
Comprehensive coverage of UK residential and business addresses
Summarised Addresses
Pre-formatted summarised addresses for easier integration
UDPRN
Includes the Unique Delivery Point Reference Number for accuracy and compatibility
Improve User Experience
Makes it easier and quicker for your customers to provide their address
Increase Online Conversions
Less friction equals increased completion rates
Reduce Costs
Increased accuracy reduces the costs associated with incorrectly labelled items
Sample Response
V2
Documentation
Introduction
This endpoint returns an array of (one or more) addresses for a given postcode.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/ukvehicledata/postcodelookup?post_code=AB21ABC
Example Sandbox Request
https://sandbox.oneautoapi.com/ukvehicledata/postcodelookup?post_code=AB21ABC
Request Parameters
post_code
mandatory, string, e.g. AB21ABC
The postcode
Sample Response
{
"success": true,
"result": {
"address_details": {
"address_qty": 1,
"address_list": [
{
"unique_delivery_point_reference_number": 12345,
"address_summary": "123456, Flat 4, ACME Motors, ACME House, 123 Fake Street, Fake Industrial Estate, York, North Yorkshire, AB21 ABC",
"address_details": {
"organisation": "ACME Motors",
"premises": "Flat 4, ACME House",
"street": "Fake Street",
"locality": "Fake Industrial Estate",
"city": "York",
"county": "North Yorkshire",
"post_code": "AB21ABC"
},
"component_details": {
"po_box_number": 123456,
"sub_building_name": "Flat 4",
"building_name": "ACME Mansion",
"building_number": 123,
"thoroughfare": "Main Street",
"street": "Fake Street"
}
}
],
"license_notice": "Usage of the AddressList data must be in accordance with the Royal Mail's PAF Data end user license terms, which can be found here: https://ukvehicledata.co.uk/policies/PAFLicencingEUA/PAFLicencingEUA.pdf"
}
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
address_qty
e.g. 1
The number of addresses returned
unique_delivery_point_reference_number
e.g. 12345
The Royal Mail unique identifier for an address
address_summary
e.g. 123456, Flat 4, ACME Motors, ACME House, 123 Fake Street, Fake Industrial Estate, York, North Yorkshire, AB21 ABC
The summary address
organisation
e.g. ACME Motors
The organisation name
premises
e.g. Flat 4, ACME House
The premises' name
street
e.g. Fake Street
Street
locality
e.g. Fake Industrial Estate
The locality
city
e.g. York
City
county
e.g. North Yorkshire
County
post_code
e.g. AB21ABC
The location of the stock vehicle used as the centre of the search.
po_box_number
e.g. 123456
The PO Box Number
sub_building_name
e.g. Flat 4
The name of the sub-building for the address
building_name
e.g. ACME Mansion
The name of the building
building_number
e.g. 123
The building number
thoroughfare
e.g. Main Street
The name of the main street
street
e.g. Fake Street
Street
license_notice
e.g. Usage of the AddressList data must be in accordance with the Royal Mail's PAF Data end user license terms, which can be found here: https://ukvehicledata.co.uk/policies/PAFLicencingEUA/PAFLicencingEUA.pdf
The street name
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com