Tethered-token system client

Authenticating with a Tethered-Token System Client ID

Team Coordinator generates refresh token in web interface

If your client will interact with PKB on behalf of a computer system, rather than a person, and if your System Client ID is an older one (rather than one that can make use of the Client Credentials Grant workflow) then in order to interact with our APIs you must be granted access by a Team Coordinator.

Depending on the details of your deployment, you might have access to the relevant Team Coordinator user already.

To grant access, the Team Coordinator should log in to the web interface, navigate to the "Institution" tab, and click on the "REST API access" button. They will need to enter your Client ID.

A refresh token will then be displayed on the screen, which they can pass to you securely.

Client exchanges refresh token for new access token

In order to receive your first access token, and to get a new access token if your current one has expired, you will need to request one using your refresh token.

You should follow the same steps as detailed in the Authorization Code Grant workflow, except that you must always send a scope value of SITE (this will allow you to call both CLINICIAN and TEAMCOORD scoped endpoints).


© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.

This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.