Spine Directory Service - LDAP API

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

This API can only be used where there is a legal basis to do so.

It is deprecated and not open to new integrations.

The following APIs are intended to replace this API:

• CIS2 Authentication - our modern authentication service for healthcare workers - which includes the ability to get all relevant details for the currently signed in user
• Healthcare Worker - FHIR API - a more modern, internet-facing API for getting healthcare worker details from SDS
• Spine Directory Service - FHIR API - an more modern, internet-facing API for getting details of accredited systems from SDS
• Organisation Data Terminology - FHIR API - a more modern, internet-facing API for getting details of organisations

This API is deprecated, meaning:

• it is still available in production
• it is still supported
• it is not open to new integrations
• it will be retired at some point (we haven't set a date yet)

If you're developing a new integration, use an alternative API.

If you're an existing user, you need to plan to migrate away.

This API is a platinum service, meaning it is operational and supported 24 hours a day, 365 days a year.

For more details, see service levels.

This API uses Lightweight Directory Access Protocol (LDAP).

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

It is not available on the internet - but we do have alternative APIs that are available on the internet.

For more details, see Network access for APIs.

For details, see part 5 of the Spine External Interface Specification.

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

This API is not open to new integrations - if you're developing a new integration, use an alternative API.

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.

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