Skip to main content
Creating a new NHS England: NHS England and NHS Digital will merge on 1 February 2023. Learn more.

Spine Directory Service - LDAP API

Access details of organisations, people and systems registered in the Spine Directory Service (SDS) using our LDAP API.

If you are developing a new integration, consider using the Spine Directory Service - FHIR API instead.


Overview

Use this API to access details from the Spine Directory Service (SDS) relating to:

  • organisations - NHS organisations, their sites and departments
  • people - healthcare workers who are Spine users, including their organisation and role
  • systems registered with Spine

Who can use this API

This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.

You must do this before you can go live (see ‘Onboarding’ below). 



API status

This API is in production.


Service level

This API is a platinum service, meaning it is operational and supported 24 x 7 x 365.

For more details, see service levels.



Network access

You can access this API via the Health and Social Care Network (HSCN).

It is not available on the internet.

For a similar API that is available on the internet, consider Spine Directory Service - FHIR API.

For more details, see Network access for APIs.


Security and authorisation


Testing

You can test this API using our Path to Live environments.


Onboarding

You must get your software onboarded before it can go live.

Contact us before onboarding with this API. It uses the Common Assurance Process (CAP) which is tailored for each NHS service.


Interactions

For a summary of how to interact with this API, see Spine Directory Service (SDS) guidance for developers.

For a full formal specification, see part 5 of the Spine External Interface Specification.


Additional guidance

For further technical resources, see Spine Directory Service (SDS) guidance for developers.

Last edited: 24 October 2022 5:27 pm