Is nhsid_useruid guaranteed to be returned from a userinfo request?

Care Identity Service (CIS2)
1

Is nhsid_useruid guaranteed to be returned from a userinfo request? Is there any documentation for the response from this API endpoint?

Thanks

2

Hi @sam.carter this documentation (linked below) should assist with your query. Do reply again if you have further questions.
4. Scopes and claims - NHS England Digital

1 Like
3

Thanks Jenna, some of the other NHS API documentation specifies a JSON schema showing which fields are required, such as below. My query is whether the nhsid_useruid will always be returned or whether it’s possible to have a response without that field included.

Thanks
Sam

image
image1176×1213 89 KB

4

Hi Sam, the response is defined by the OIDC specification and isn’t part of the normal API documentation - as such the content will depend on the scopes provided - if the nhsperson scope is given during the authenticate call, then the response will always have the nhsid_userid claim as detailed in the link shared by Jenna

1 Like
5

Ok, thanks for the responses both.

1 Like