Smartcard authentication

API Platform
, , ,
2

Hi Tom,

Accessing the NHS Integration environment using a Smartcard requires specific configurations and permissions. The error message “Smart card Authentication Error” suggests that your smartcard may not be set up for this environment.

I would suggest the following steps:

  1. Verify Smartcard Registration for the Integration Environment: Smartcards are environment-specific, so check and ensure your smartcard is registered for the Integration environment. If it’s not, you’ll need to request a new smartcard or have your existing one configured appropriately. Contact the Platform Support team at platforms.supportdesk@nhs.net to request the necessary setup.

Follow link for more guidance on this: https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication/onboarding-journey/gain-access-to-the-integration-environment

  1. Install and Configure the NHS Identity Agent: The NHS Identity Agent facilitates communication between your smartcard and NHS systems. Ensure the agent is installed and configured to point to the Integration environment. You can download the Identity Agent from the NHS Digital website (HSCN connection required). After installation, adjust the registry settings to align with the Integration environment’s configurations.

Follow link for more guidance on this: https://digital.nhs.uk/services/care-identity-service/setting-up-and-troubleshooting/how-to-set-up-a-smartcard-user-workstation

  1. Install NHS Credential Management: This component is essential for smartcard authentication, especially with Series 9 smartcards. Ensure that NHS Credential Management v1.4.2.0 is installed on your device. You can download it from the NHS Digital website (HSCN connection required).

Follow link for more guidance on this: https://digital.nhs.uk/services/care-identity-service/applications-and-services/technical-services/credential-management

  1. Check HSCN Connectivity: Access to the Integration environment typically requires a connection to the Health and Social Care Network (HSCN). Ensure your network is configured correctly and that your firewall settings permit communication with the necessary NHS services.

Follow link for more guidance on this: https://digital.nhs.uk/services/path-to-live-environments/connect-to-a-path-to-live-environment

By ensuring your smartcard is registered for the Integration environment and that all necessary components are correctly installed and configured, you should be able to authenticate successfully. If issues persist after following these steps, reach out to the Platform Support team at platforms.supportdesk@nhs.net for further assistance.

Thanks,

NHS England API Platform team

Please note: The API Platform team can only address queries relevant to the NHS England API platform, including security, rate limiting, logging, monitoring and alerting. For any API specific queries, please reach out the relevant API teams.