Skip to main content

Spine Directory Service - LDAP API

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

Overview

Use this API to access details of organisations, people and systems registered in the Spine Directory Service (SDS).

Legal use

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). 

Related APIs

The following APIs are related to this one:

API Status

This API is stable.

Technology

Network access

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

It is not available on the internet.

For more details, see Network access for APIs.

Security and authorisation

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

Testing

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

Onboarding

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

As part of onboarding, this API uses the Common Assurance Process (CAP), which is tailored for each NHS service. For more details, contact us.

Interactions

For details of interactions for this API, see part 5 of the Spine External Interface Specification.

Last edited: 16 December 2020 12:47 pm