---
search:
  tags:
    - Users
    - GET
seo:
  description: >-
    Returns the caller's current user and member details, including the scopes
    the credential holds. Reference for the GET /users/me endpoint in the REST
    API.
sidebar:
  label: Get the Current User
  badge: GET
title: Get the Current User
type: openapi-operation
---
Returns the caller's current user and member details, including the scopes the credential holds.

### Endpoint

- Method and path: `GET /users/me`
- Operation ID: `getCurrentUser`
- API reference: [GET /users/me](/api-reference/rest/users/get-current-user)
- Complete specification: [OpenAPI (YAML)](/openapi.yml)
- Spec location (JSON Pointer): `#/paths/~1users~1me/get`

#### Authorization

- Accepted credentials: `UDX-Access-Key` header and `UDX-Access-Timestamp` header and `UDX-Access-Signature` header; or Bearer token in `Authorization`
- Details: [Authentication](/reference/authentication)

#### Parameters

```yaml
- $ref: "#/components/parameters/VersionHeader"
```


#### Responses

##### `200`

The active direct-access user.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/json`

Schema:

```yaml
$ref: "#/components/schemas/UserResponse"
```

Example: Example

```json
{
  "user": {
    "id": "7391077406361930804",
    "member_id": "3517456229634185646",
    "rfq_participant_id": "4d127cce3bc675c9",
    "scopes": [
      "read",
      "trade"
    ]
  }
}
```

##### `401`

No valid credential was provided.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Authentication failed

```json
{
  "type": "urn:udx:problem:invalid-authentication-credentials",
  "title": "Unauthorized",
  "status": 401,
  "detail": "invalid authentication credentials",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `403`

The signed-in user does not have UDX access.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: No UDX access

```json
{
  "type": "urn:udx:problem:access-unavailable",
  "title": "Forbidden",
  "status": 403,
  "detail": "UDX access is not available",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```

##### `500`

Something went wrong on UDX's side.

Headers:

```yaml
UDX-Version:
  $ref: "#/components/headers/VersionHeader"
```

Content type: `application/problem+json`

Schema:

```yaml
$ref: "#/components/schemas/ProblemDetails"
```

Example: Internal server error

```json
{
  "type": "urn:udx:problem:internal-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "internal error",
  "instance": "urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef"
}
```


#### Referenced definitions

The references in the excerpts above resolve to these definitions in the complete specification.

##### `#/components/headers/VersionHeader`

```yaml
description: API version used for this response.
schema:
  type: string
  maxLength: 10
  description: A dated API version (YYYY-MM-DD).
  example: 2026-07-15
```

##### `#/components/schemas/UserResponse`

```yaml
type: object
description: The current user.
required:
  - user
properties:
  user:
    $ref: "#/components/schemas/User"
```

##### `#/components/schemas/User`

```yaml
type: object
description: The canonical user the caller's credential resolves to.
required:
  - id
  - member_id
  - rfq_participant_id
  - scopes
properties:
  id:
    $ref: "#/components/schemas/EntityId"
  member_id:
    type: string
    minLength: 1
    description: The member that owns this user.
    example: "6820943174116859281"
  scopes:
    type: array
    maxItems: 7
    items:
      $ref: "#/components/schemas/APIKeyScope"
    description: The scopes the calling credential holds. For a bearer session these are the user's scopes; for an API key they are the key's scopes, which never exceed the owning user's.
  rfq_participant_id:
    type: string
    minLength: 1
    maxLength: 64
    description: The identifier this user is known by to RFQ counterparties.
    example: 4d127cce3bc675c9
```

##### `#/components/schemas/EntityId`

```yaml
type: string
minLength: 1
description: An exchange-assigned identifier. Treat it as an opaque, stable key with no internal structure.
example: "6820943174116859281"
```

##### `#/components/schemas/APIKeyScope`

```yaml
type: string
description: A permission granted to an API key.
enum:
  - accounts:manage
  - funds:transfer
  - grants:manage
  - keys:manage
  - read
  - trade
  - users:manage
```

##### `#/components/schemas/ProblemDetails`

```yaml
type: object
description: An RFC 9457 machine-readable error, returned on every non-2xx response. The response's Content-Language header identifies the language used by title and detail, and Vary includes Accept-Language.
required:
  - type
  - title
  - status
properties:
  type:
    type: string
    format: uri-reference
    maxLength: 2048
    description: A stable URN identifying the kind of problem, for example urn:udx:problem:insufficient-permissions. Branch on it rather than on the localized detail. It is an identifier, not a URL to dereference.
  title:
    type: string
    maxLength: 40
    example: Bad Request
    description: A localized, human-readable summary of the error category. Stable for a given status code and resolved language — clients must not use it as a machine-readable discriminator.
  status:
    type: integer
    example: 400
    description: The HTTP status code, repeated from the response itself.
  detail:
    type: string
    maxLength: 500
    example: malformed request body
    description: A localized, human-readable explanation specific to this occurrence. Clients must not parse it for machine-readable information.
  instance:
    type: string
    format: uri-reference
    maxLength: 100
    example: urn:request-id:8f14e45f-ceea-4abc-a743-e89a34d3f6ef
    description: An identifier for this specific occurrence, so it can be correlated with server-side logs if you need to report it.
```

##### `#/components/parameters/VersionHeader`

```yaml
name: UDX-Version
in: header
required: false
description: Dated API version (YYYY-MM-DD).
schema:
  type: string
  minLength: 10
  maxLength: 10
  description: A dated API version (YYYY-MM-DD).
  example: 2026-07-15
```

