---
title: "Get authenticated user info (OIDC UserInfo)"
method: GET
path: "/v1/oauth/userinfo"
tags: ["OAuth"]
---

# Get authenticated user info (OIDC UserInfo)

`GET /v1/oauth/userinfo`

## Request

- Base URL: `https://api.1claw.co`
- URL: `https://api.1claw.co/v1/oauth/userinfo`
- Auth: HTTP bearer

Standard OIDC UserInfo endpoint. Returns claims about the authenticated user
based on the granted scopes.

Scopes: `profile` for `name`, `email` for `email`, `wallet` for
`wallet_address`, and `referral` for `referral_code` and `referral_link`.
A non-OAuth user token sees every field, since it is the user's own data.

`referral` is separate from `profile` deliberately: a referral code is
something the holder is asked to spread, so an app has to request it by name
and the consent screen names it.

## Response `200`

User info

- OAuthUserInfoResponse
  - `sub` string, uuid, required
  - `email` string, email, required
  - `name` string, nullable
  - `wallet_address` string, nullable
  - `referral_code` string, nullable: The user's referral code, returned only under the `referral` scope. Minted on first read, so a user signing in to a partner site for the first time still gets one.
  - `referral_link` string, nullable: The same code as a shareable URL, built for the brand the request arrived on — returned so a host app never has to assemble it and pick the wrong domain.

## Other responses

- `401`: Authentication required or invalid

---

[API](https://skmtc.dev/1claw/apis/1claw-api.md) · [All operations](https://skmtc.dev/1claw/apis/1claw-api/llms.txt) · [OpenAPI document](https://skmtc.dev/1claw/apis/1claw-api/revisions/ae109b496830?raw)
