User Profiles

Request

Once you have an access token for a user, you can make an HTTP GET request to our API to retrieve their verification information, including that access token. We have two options for authenticating this request.

If you configured an OAuth 2 client in the previous step that automatically authenticates API requests with the access token it obtained, you should check that it is configured to use one of the methods listed here.

Authorization header (recommended)

GET https://accounts.studentbeans.com/api/v3/me.json

Including HTTP header:

Authorization: Bearer ACCESS_TOKEN

Query parameter

GET https://accounts.studentbeans.com/api/v3/me.json?access_token=ACCESS_TOKEN

Note the domain: accounts.studentbeans.com.

Response

You will receive a JSON-formatted response on success, and an empty HTTP response with an appropriate status code in case of error, examples of which are below.

Verified (one supergroup)

The user has an active verification in one supergroup.

{
  "sbid_number": "ABC45FG",
  "verifications": [
    {
        "supergroup": "student-graduate",
        "expires_on": "2026-03-18"
    }
  ]
}

Verified (several supergroups)

The user has active verifications in more than one supergroup.

{
  "sbid_number": "ABC45FG",
  "verifications": [
    {
        "supergroup": "student-graduate",
        "expires_on": "2026-03-18"
    },
    {
        "supergroup": "key-worker",
        "expires_on": "2026-04-28"
    }
  ]
}

Not verified

The user has no active verifications.

{
  "sbid_number": "ABC45FG",
  "verifications": []
}

info

We will typically only redirect a user back to you when they have successfully verified with the group they have selected, or if they are already verified. However, if you are still using an access token granted in the past, a user's verifications may have expired, or they may have a new verification pending. In these cases, those verifications will not be included in the API response.