---
title: "Get Self"
method: GET
path: "/v2/users/self"
tags: ["Users"]
---

# Get Self

`GET /v2/users/self`

Get the user's details

## Response `200`

Get User Details

- UserResponse
  - `id` string, uuid — The id of the user
  - `status` 'ENABLED' | 'DISABLED' | 'PENDING' — The status of the user when the user has been invited but not yet enrolled they will have a PENDING status
  - `email` string, email — the email address of the user
  - `smsNumber` string — The phone number of a device that the user can receive sms messages on
  - `primaryContactNumber` string — The main contact number for the user
  - `secondaryContactNumber` string — The secondary contact number for the user
  - `firstName` string
  - `lastName` string
  - `entityId` string, uuid — The payorId or payeeId or null if the user is not a payor or payee user
  - `companyName` string — The payor or payee company name or null if the user is not a payor or payee user
  - `roles` Role[] — The role(s) for the user
    - `name` string, required — the name of the role
  - `userType` 'BACKOFFICE' | 'PAYOR' | 'PAYEE' — Indicates the type of user. Could be BACKOFFICE, PAYOR or PAYEE.
  - `mfaType` 'SMS' | 'YUBIKEY' | 'TOTP' — The type of the MFA device
  - `mfaStatus` 'REGISTERED' | 'UNREGISTERED' | 'VERIFIED' — The status of the MFA device
  - `lockedOut` boolean — If true the user is currently locked out and unable to log in
  - `lockedOutTimestamp` string, date-time, nullable — A timestamp showing when the user was locked out If null then the user is not currently locked out

## Other responses

- `401` — Invalid access token. May be expired or invalid
- `403` — The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

## Changes

- **2026-07-13** `05c3f09fc50a` — 1 warning
  - added the new `VERIFIED` enum value to the `mfaStatus` response property for the response status `200`
- **2021-11-03** `12abf05c40fa` — 2 info
  - added the optional property `companyName` to the response with the `200` status
  - added the optional property `userType` to the response with the `200` status
- **2020-09-25** `dd71433847a6` — 2 breaking, 12 info
  - the `errors/items/` response's property type/format changed from ``/`` to `object`/`` for status `401`
  - the `errors/items/` response's property type/format changed from ``/`` to `object`/`` for status `403`
  - added the optional property `errors/items/errorCode` to the response with the `401` status
  - added the optional property `errors/items/errorCode` to the response with the `403` status
  - …10 more
- **2020-08-13** `75bb7af5ae63` — 3 info
  - the `primaryContactNumber` response's property pattern was changed from `^\+?[1-9]\d{1,14}$` to `^\+[1-9]\d{1,14}$` for the status `200`
  - the `secondaryContactNumber` response's property pattern was changed from `^\+?[1-9]\d{1,14}$` to `^\+[1-9]\d{1,14}$` for the status `200`
  - the `smsNumber` response's property pattern was changed from `^\+?[1-9]\d{1,14}$` to `^\+[1-9]\d{1,14}$` for the status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v2/users/self/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/velopaymentsapi/velo-payments-apis/revisions/05c3f09fc50a/schema)