---
title: "Get User"
method: GET
path: "/v2/users/{userId}"
tags: ["Users"]
---

# Get User

`GET /v2/users/{userId}`

Get a Single User by Id.

## Path parameters

- `userId` string, uuid, required

## 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
  - `roles` Role[] — The role(s) for the user
    - `name` string, required — the name of the role
  - `mfaType` 'SMS' | 'YUBIKEY' | 'TOTP' — The type of the MFA device
  - `mfaStatus` 'REGISTERED' | 'UNREGISTERED' — 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
- `404` — Resource not found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 4 breaking, 3 warning
  - the response's body type changed from `object` to no type for status `401`
  - the response's body type changed from `object` to no type for status `403`
  - the `errors/items/` response's property type changed from `object` to no type for status `401`
  - the `errors/items/` response's property type changed from `object` to no type for status `403`
  - …3 more
- **2019-12-11** `a0b19fa311c0` — 1 info
  - endpoint added
- **2019-07-15** `ced8e167a97c` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v2/users/:userId/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.dev/velopaymentsapi/apis/velo-payments-apis/revisions/1b2abf26b5d6?raw)