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

NHS login API

Access multiple digital health and social care services with a single login for patients and the public.

Overview

Use this API to enable patients and the public to access multiple digital health and social care services with NHS login, a single re-usable login.

You benefit from:

  • using a trusted and secured identity platform
  • choosing a proper level of end user verification
  • displaying a brand name the public recognises
  • meeting the Identity Verification and Authentication Standard (DCB3051)

For more details, see NHS Login: guidance for partners and developers.


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 and review if the NHS login fits your needs before you go too far with your development.

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



API status and roadmap

This API is in production.

To find out what we are working on now and what we plan to do in the future, see the Roadmap.


Service level

This API is a silver plus service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays. However, we respond to severity 1 and severity 2 incidents outside of business hours.

For more details, see service levels.


Technology

This API uses OpenID Connect 1.0 (OIDC) authentication standard which is a simple identity layer on top of the OAuth 2.0 protocol.

For guidance on OIDC 1.0 and how to to verify the identity of patients and obtain their basic profile information, see The OIDC login flow.


Network access

This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN).

For more details see Network access for APIs.


Security and authorisation

The security model for this API conforms to OpenID Connect 1.0 (OIDC)

For security and authentication details, see section 7 Partner Services and Security in the NHS login External Interface Specification


Environments and testing

For details on different environments and associated testing, see the NHS login integration toolkit.


Onboarding

You need to get your software approved by NHS login before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.

For onboarding with NHS login, follow the guidance available at:


Interactions

For interaction details, see section 5 Data view in the NHS login External Interface Specification.

Last edited: 13 January 2023 11:05 am