LogoLogo
OS Docs HomeOS NGDOS APIsOS Download ProductsMore than MapsOS Data Hub
  • Introduction to OS APIs
  • Core Concepts
    • Getting started with an API project
    • Authentication
    • Error codes
    • Rate-limiting policy
    • OS API branding
    • Service level agreements
    • Service availability dashboard
  • Accessing OS APIs
    • OS Maps API
      • Layers and styles
      • Getting started
        • ESRI ArcGIS Online
        • ESRI ArcGIS Pro
        • ESRI ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • ZXY
        • WMTS
      • Code examples
    • OS Vector Tile API
      • What data is available?
      • Getting started
        • ESRI ArcGIS Pro
        • Cadcorp SIS
        • QGIS
        • Create a web application using the OS Vector Tile API
      • Technical specification
        • Service Metadata
        • Stylesheet
        • Tile request
      • Code examples
      • Stylesheets
    • OS NGD API – Tiles
    • OS NGD API – Features
    • OS Features API
      • OS Product Archive
      • What data is available?
      • Getting started
        • ArcGIS Online
        • ArcGIS Pro
        • ArcMap
        • Cadcorp SIS
        • MapInfo Pro
        • QGIS
      • Technical specification
        • getCapabilities
        • describeFeatureType
        • getFeature
        • Filtering
        • Paging
        • Empty values
      • Code examples
    • OS Names API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Nearest
      • Code list
      • Code examples
    • OS Linked Identifiers API
      • What data is available?
      • Getting started with implementing a look-up application
      • Technical specification
        • Identifier
        • Identifier Types
        • Feature Types
        • Product Version Information
      • Code examples
    • OS Places API
      • Getting started with example queries using Node.js
      • Technical specification
        • Find
        • Postcode
        • UPRN
        • Nearest
        • BBOX
        • Radius
        • Polygon
      • Datasets
      • Code lists
      • Code examples
    • OS Match & Cleanse API
      • End of Life Information
      • Getting started with an example match query using Node.js
      • Technical specification
      • Datasets
      • Code lists
    • OS Downloads API
      • Getting started
        • Automating OS OpenData downloads
        • Automating OS Premium data downloads
      • Technical specification
        • OpenData products
        • OpenData product details
        • Download an OpenData product
        • OpenData product image
        • Data packages
        • Data package ID
        • Data package version
        • Data package version ID
        • Download a data package
    • OAuth 2 API
      • Getting started
      • Technical specification
  • Additional resources
    • OS API Wrappers
      • JavaScript
      • Python
      • R
  • Extra Links
    • Accessibility
    • Contact us
    • PSGA Product Summary
    • Terms and conditions
Powered by GitBook
On this page
  • Overview
  • Key dates
  • Why is this happening?
  • Impact on customers
  • Migration options
  • OS Partner solution
  • OS Places API
  • Further information

Was this helpful?

  1. Accessing OS APIs
  2. OS Match & Cleanse API

End of Life Information

Overview

The OS Match & Cleanse API will be officially withdrawn on 31 March 2026. This page provides details on the timeline, impact, and available alternatives for affected customers.

Key dates

  • Full End of Life date: 31 March 2026

Why is this happening?

We continuously evaluate our APIs to ensure they align with our strategic goals and meet the evolving needs of our customers. After evaluating the OS Match & Cleanse API, we've made the decision to withdraw it. Here's why:

  • Evolving customer needs: Feedback has shown that the OS Match & Cleanse API does not fully address key use cases. Many customers are looking for a bulk address-matching solution to validate and link existing address data to a Unique Property Reference Number (UPRN). Currently, the API does not support bulk processing and has rate limits that restrict processing large batches of addresses, meaning it's not the best fit for those use cases. Additionally, various bulk address-matching solutions are supported throughout the OS Partner community.

  • Low usage and adoption: Over time, the usage of the OS Match & Cleanse API has been relatively low, making continued support and maintenance no longer sustainable.

  • Similar functionality is available: The OS Places API provides functionality comparable to the OS Match & Cleanse API through the FIND endpoint.

  • OS product consolidation: The withdrawal is part of a broader initiative to streamline and consolidate our product offering, ensuring our products are sustainable and better aligned with current and future customer needs.

We understand this change will impact some customers, and we are committed to providing guidance and support to ensure a smooth transition.

Impact on customers

  • Customers can continue to use the OS Match & Cleanse API up to 31 March 2026.

  • After the End of Life date, the OS Match & Cleanse API will be removed from all existing API projects and will no longer be accessible.

  • After the End of Life date, requests to the OS Match & Cleanse API will fail.

Migration options

OS Partner solution

OS Places API

Further information

  • Further support documentation will be shared soon to answer any queries you might have and to support migration.

  • Be sure to test and validate any new implementations to ensure continued functionality in your application.

PreviousOS Match & Cleanse APINextGetting started with an example match query using Node.js

Last updated 2 months ago

Was this helpful?

Many of our OS Partners offer great address matching solutions with bulk matching capabilities that may be ideal for various customer use cases. If you'd like to chat more about alternative solutions, please reach out to your account manager who can provide specific options. You can also check out our for more information.

If you are currently using the OS Match & Cleanse API, we recommend considering a transition to the as an alternative solution. The OS Places API offers similar features and capabilities that may meet your needs.

We will provide more information on migrating to the OS Places API soon. In the meantime, for additional detail, please visit the .

This page will be regularly updated with additional documentation, including specific migration guidance and FAQs to support you. Please check this page regularly or if you have any concerns or questions.

OS Partner Finder
OS Places API
OS Places API documentation
reach out to our support team