---
title: "View a user"
method: GET
path: "/user/v3/{id}"
tags: ["User Management"]
---

# View a user

`GET /user/v3/{id}`

## Request

- Base URL: `https://api.nexiopaysandbox.com`
- URL: `https://api.nexiopaysandbox.com/user/v3/{id}`
- Auth: HTTP basic

FROM MANAGEMENT.JSON

[ggg 2024-02-27] Keeping out of main API because WhoAmI is better and returns same parameters. 

Returns user information based on the provided ID.

<div style="display:none;">

## Request parameters
- id

## Response parameters
- userName
- firstName
- lastName
- phone
- enabled
- notifications
- accessRights
- accessRights.merchantIds
- accessRights.role
- accountId
- role
- customAccess
- cognitoSub
- isEnabledForVTerm
- shouldShowPlatformAgreement
- shouldShowPricingAgreement
- dateCreated
- dateLastModified

</div>

## Path parameters

- `id` integer, required

## Response `200`

Success

- object
  - `accountId` string: Indicates the Nexio ID of the account the user is associated with.
  - `userName` string: The username for the account.
  - `accountType` string: Indicates the type of account, which affects what features are available. Typically, will be `MERCHANT` or `PARTNER`.
  - `enabled` boolean: Indicates `true` if the user account is enabled.
  - `firstName` string: The user's first name.
  - `lastName` string: The user's last name.
  - `phone` string: The user's phone number.
  - `address1` string: The business's physical address.
  - `address2` string: Additional business physical address information, if aline .
  - `city` string: The business's city.
  - `state` string: The business's state. The value must be the [two-character state abbreviation](https://pe.usps.com/text/pub28/28apb.htm).
  - `postalCode` string: The business's postal code.
  - `country` string: The [two-character (Alpha-2) ISO country code](https://www.iso.org/obp/ui/#search/code/) for the business's address.
  - `businessLegalName` string: The business's legal name.
  - `billingContactFullName` string: The business billing contact's full name.
  - `billingContactPhone` string: The business billing contact's phone number. Must be 10 characters long and include only digits.
  - `billingContactEmail` string, email: The business billing contact's email address.
  - `isApiUser` boolean: Indicates whether the user has the API user role.
  - `isEnabledAuthorizedStatus` boolean: Indicates `true` when the account is configured to use "authorized" status. Indicates `false` when the account is configured to use "pending" status.
  - `isEnabledForCybersourceAccountUpdater` boolean: Indicates whether the user is enabled for the [Account Updater](doc:working-with-account-updater) feature.
  - `isEnabledForAccountUpdater` boolean: Indicates whether the user is enabled for the legacy version of the [Account Updater](doc:working-with-account-updater) feature.
  - `accessRights` object: The user's access rights.
    - `merchantIds` object: A list of all the merchant IDs the user has access to, along with the level of access.<br/> The merchant ID is the key; the role is the value. Possible roles are R (View-Only, has the ability to view data), W (Standard, can perform actions on data such as void, refund process, etc.), or A (Admin, has all the permissions of a standard user and can also create and edit other users).
      - `[merchant ID]` string: The merchant ID for a specific account.
    - `role` string: The user's level of access for a specific account. Possible values include the following: * R - View-Only, has the ability to view data * W - Standard, can perform actions on data such as void, refund process, etc. * A - Admin, has all the permissions of a standard user and can also create and edit other users
  - `payoutAccessRights` object: The user's access rights for Payouts.
    - `[payout account ID]` string: A list of all the payout account IDs the user has access to, along with the level of access.<br/> The payout account ID is the key; the role is the value. Possible roles are R (View-Only, has the ability to view data), W (Standard, can perform actions on data such as void, refund process, etc.), or A (Admin, has all the permissions of a standard user and can also create and edit other users).
  - `loginInfo` object: Indicates login information to the Nexio Dashboard for this user.
    - `count` integer: Indicates the number of times this user has logged into the Dash.
    - `lastLogin` string, date-time: The date and time of the last login to the Dashboard as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `notifications` object: Indicates which email notifications the user subscribed to receive.
    - `chargebacks` boolean: Indicates whether the user subscribed to receive email notifications about chargebacks.
    - `largeExports` boolean: Indicates whthe user subscribed to receive email notifications about large exports.
    - `fraud` boolean: Indicates whether the user subscribed to receive email notifications about fraud.
    - `payoutBatches` boolean: Indicates whether the user subscribed to receive email notifications about payout batches.
  - `role` string: The user's custom role.
  - `dateCreated` string: The date and time at which the user was created, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `dateLastModified` string: The date and time at which the user was last modified, formatted as an [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) date expressed in UTC.
  - `cognitoSub` string: For Nexio use only.
  - `isEnabledForVTerm` boolean: For Nexio use only.
  - `shouldShowPlatformAgreement` boolean: For Nexio use only.
  - `shouldShowPricingAgreement` boolean: For Nexio use only.

## Other responses

- `401`: Unauthorized. For help with this error and other error codes, see [Common errors](doc:common-errors) in the Guides area.

---

[API](https://skmtc.dev/nexiopay/apis/internal-only.md) - [All operations](https://skmtc.dev/nexiopay/apis/internal-only/llms.txt) - [OpenAPI document](https://skmtc.dev/nexiopay/apis/internal-only/revisions/93ac8b94e0df?raw)