Digital Staff Passport integration announcements

We’ll use this topic to make announcements relevant to integrating with the Digital Staff Passport. If you’re interested, subscribe to this topic.

In the past few weeks we have released integration guidance for Digital Staff Passport.

There are three key resources:

  1. General integration guidance
  2. ‘Direct to wallet’ integration standard
  3. API standard

We’ll be iterating these resources over time. We’ll reply to this topic to announce any significant updates.

We’ve updated the Digital Staff Passport API standard as follows:

  1. Added a new ‘Get API status’ operation - this needs to be implemented by all external systems to allow our live service monitoring tools to check the health of the API
  2. Add an employee record operation - clarification that currentAddressVerified (for DBS check information) might not always be true in the future.

We’ve now updated the Digital Staff Passport API standard to include the following use cases:

  • Send a DBS check outcome from DSP to a recruitment system
  • Receive a DBS check outcome from a recruitment system to DSP

We’ve updated the Digital Staff Passport API standard as follows:

  • Added link to new integration testing page

  • Added link to new onboarding and assurance page

  • Removed data fields dbsUpdateServiceWebsiteCheckDate and dbsUpdateServiceWebsiteMatch from the DBS supplementary information record

  • Fixed a few typos

  • Send a DBS check outcome from DSP to a recruitment system

  • Receive a DBS check outcome from a recruitment system to DSP

We’ve now updated the Digital Staff Passport API standard as follows:

  • New use case: send professional registration to recruitment system
  • Changes to error response scenarios affecting HTTP status codes 401 (unauthorized), 403 (forbidden) and 409 (conflict)
  • New data attribute “dbsUpdateServiceStatusCheckDate” for DBS check outcomes - indicates the date the DBS update service was checked, if was checked.
1 Like

We’ve now updated the Digital Staff Passport API standard as follows:

  • New use case: send and receive screening and immunisation information
  • Removed JTI claim from the JWT body in the security pattern
  • Added maximum image size to images in right to work record type
  • Added details of how to send pro-active notifications to DSP, via a new inbound DSP API

We’ve now updated the Digital Staff Passport API standard as follows:

  • added workforce type, registered body number and registered body name to DBS check outcome record
  • removed DBS update service status check date from DBS check outcome record - we’re not supporting the handling of DBS update service checks for now
  • added a variant security pattern ‘federated identity’ to help support external systems built on Microsoft Azure
  • altered the token timeout of 600 seconds in the security pattern to be advisory not mandatory