NHS login developer documentation

Menu

  • NHS login

  • What is NHS login
  • The OIDC login flow
  • Integrating with NHS login

  • The NHS login integration process
  • NHS login user journeys
  • Adding the NHS login button to your service
  • Sharing a user's NHS login information with your service
  • Artificial intelligence (AI)
  • Provisioning accounts

  • What is account provisioning?
  • Users Endpoint V2

  • What is Users Endpoint V2?

NHS login

  • What is NHS login?
  • The OIDC login flow

Integrating with NHS login

  • The NHS login integration process
  • NHS login user journeys
  • Adding the NHS login button to your service
  • Sharing a user's NHS login information with your service
  • Artificial intelligence (AI)

Testing NHS login

  • Compare NHS login environments
  • Integrate to the sandpit
  • Generate public key
  • Test data
  • Testing scenarios

External Interface Specification

  • Identity Federation External Interface Specification

Provisioning accounts

  • What is account provisioning?
  • Provision Account External Interface Specification

Users Endpoint V2

  • What is Users Endpoint V2?
  • Users Endpoint V2 External Interface Specification

Conformance

  • Technical Conformance

Developer Support Information

  • Developer Support

Features

  • Biometric FIDO authentication
  • GP credentials
  • Medium (P5) to high (P9) verification step-up journey
  • Multiple redirect URIs
  • NHS login user settings
  • Scopes and claims
  • Session management
  • Single Sign On (SSO)
  • Vectors of Trust

Code examples

  • Example OIDC clients

Users Endpoint V2 External Interface Specification

This specification document defines the Users Endpoint V2 interface we use and describes the data flow supported by this interface.


Edit this page on GitHub

Support links

  • GitHub
  • Developer support
  • Contact us

© Crown copyright