Deprecation notice: Spine Directory Service LDAP API

On 30 June 2027:

• we will reduce the service level for the Spine Directory Service (SDS) LDAP API from platinum to gold

• this will reduce support hours and availability targets

On 30 September 2027:  

• we will reduce the service level for the Spine Directory Service (SDS) LDAP API from gold to silver

• this will reduce support hours and availability targets

By 30 September 2028, we will retire the SDS LDAP API, meaning it can no longer be used. 

The SDS LDAP API uses legacy technology which is hard to integrate with. We have built replacement APIs using modern RESTful APIs conforming to the FHIR standard that are easier to integrate with.

The SDS LDAP API is only available over HSCN, whereas the replacement APIs are internet-facing.

The SDS LDAP API gives us limited control over the queries that API consumers can run, making it difficult to manage performance and availability.

In particular, the SDS LDAP API allows API consumers to run queries to retrieve details for all healthcare workers, including personally identifiable information.

The SDS LDAP API gives us limited visibility of who is using it.

By retiring the SDS LDAP API, we have the opportunity to move the underlying data to an alternative tech stack, which might improve performance, maintainability or cost.

In particular, for healthcare worker data, it allows us to work on strategic plans to improve the scope and quality of the data.

Suppliers using the SDS LDAP API need to migrate to one or more of the replacement APIs.

On 28 May 2026, all known API consumers of the SDS LDAP API were sent an email notifying them of the deprecation of the API. The distribution list was based on historic information we held for suppliers and might not have reached all parties.

Find out more about migrating away from the SDS LDAP API.