Request user information

Request

GET https://identity.company-information.service.gov.uk/user/profile

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
https://identity.company-information.service.gov.uk/user/profile.read User profile read permission

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

User profile returned

 userProfile
401 Unauthorized

Invalid or expired access token

Example

GET /user/profile HTTP/1.1
Host: https://identity.company-information.service.gov.uk
Authorization: Bearer 12397h2giu24g2o0781y3r9181-1r9uhf19fh13f98h1f:1fiubfv81g3f

HTTP/1.1 200 Found
Access-Control-Allow-Origin: *
Connection: close
Content-Type: application/json; charset=utf-8

{
    "surname"  : "users-surname",
    "forename" : "users-forename",
    "email"    : "user@somedomain.com",
    "id"       : "sdvojdfg9whege7r89wqyg02e7tr0134o",
    "locale"   : "en-GB"
}