Code lists
A code list is a controlled set of allowable values that can be used within a query parameter or included in the response. This page show the code lists used within OS Match & Cleanse API.
Logical status code
Logical status of an address record as given by the local custodian. These attributes show whether the address is currently live, provisional or historic.
| Logical status code | Logical status description |
|---|---|
| Approved address |
| Provisional address |
| Historic address |
LPI logical status code
| Logical status code | Logical status description |
|---|---|
| Approved address |
| Alternate address |
| Provisional address |
| Historic address |
Country code
Code representing the geographical territory that the Address is located within, where a geographical territory represents either a devolved country or an island nation.
| Country code | Country code description |
|---|---|
| This record is within England |
| This record is within Wales |
| This record is within Scotland |
| This record is within Northern Ireland |
| This record is within Channel Islands |
| This record is within Isle of Man |
| This record is not assigned to a country as it falls outside of the land boundaries used |
Classification Code
An alphanumeric code used to classify the object using the AddressBase Classification Scheme, which is available to download from the AddressBase Product Support page of the OS website.
BLPU state code
| BLPU State Code | BLPU state description |
|---|---|
1 | Under construction |
2 | In use |
3 | Unoccupied / Vacant / Derelict |
4 | No longer existing |
6 | Planning permission granted |
RPC code
| RPC Code | RPC description |
|---|---|
1 | Central Internal Position |
2 | General Internal Position |
3 | Transitional Position |
4 | Street Location |
5 | Postcode Unit Position |
9 | Low accuracy – marked for priority review |
Match scores and descriptions
Every address record returned will have MATCH and MATCH_DESCRIPTION attributes which can help you select the most appropriate one:
| Match score | Match description |
|---|---|
| Exact |
| Good |
| Partial |
| No Match |
Example searches and their match scores
If an exact match isn’t found, then the results will be returned in an order based on their match scores. The match score can help you select the most appropriate address record. These example searches show the affect that different search terms and the use of different parameters can have on the match score of the top result returned:
| Query | Match score |
|---|---|
|
|
|
|
|
|
| No result |
Tips to improve your match results
Match results can be greatly improved by including commas to separate your search terms e.g. ‘Ordnance Survey, 4, Adanac Drive, Nursling, Southampton, SO16 0AS’
Make sure the address elements in your search are in the correct order.
Make sure you provide enough information when searching for an address. Remember that postcodes can cover up to 99 properties, therefore including a street name and building name/number will narrow down the search results.
Don't over complicate your search with unnecessary elements e.g. ‘Room 301, Level 3, Organisation Name, Building Name, Street, Postcode’ includes information that is not held in the database (Room 301, Level 3) and could be removed from the search to help improve the results.
Remember that organisations move or change names, therefore if your results are not satisfactory, consider only searching on Building Name, Street and Postcode instead.
Make sure that postcodes in your search are current as they can be terminated. One option for this is to use the Office for National Statistics Postcode Directory (ONSPD). ONSPD identifies out-of-date postcodes with the date of termination (doterm attribute), where, when populated, provides the date when the postcode was terminated.
Use the Country code filter parameter to limit results from specific countries only.
Last updated