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)
  • Testing NHS login

  • Compare NHS login environments
  • Integrate to the sandpit
  • Generating public key
  • Test data
  • Testing scenarios
  • External Interface Specification

  • Identity Federation External Interface Specification
  • Provision Account External Interface Specification
  • Conformance

  • Technical Conformance
  • Developer Support Information

  • Developer Support
  • Features

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

  • Example OIDC clients

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

  • Provision Account 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

Provision Account External Interface Specification

NHS login uses OAuth 2.0 to send basic profile information about the end user to partner services.

This specification document defines the provision account interface we use and describes the data flow supported by this interface.


Edit this page on GitHub

Support links

  • Github
  • Slack
  • engage.nhslogin@nhs.net

© Crown copyright