Sign in

v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
User Management

View a user

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>
get/user/v3/{id}

Path parameters

idinteger required
Example:837

The user ID.

Response

Success

accountIdstring

Indicates the Nexio ID of the account the user is associated with.

userNamestring

The username for the account.

accountTypestring

Indicates the type of account, which affects what features are available. Typically, will be MERCHANT or PARTNER.

enabledboolean

Indicates true if the user account is enabled.

firstNamestring

The user's first name.

lastNamestring

The user's last name.

phonestring

The user's phone number.

address1string

The business's physical address.

address2string

Additional business physical address information, if aline .

citystring

The business's city.

statestring

The business's state. The value must be the two-character state abbreviation.

postalCodestring

The business's postal code.

countrystring

The two-character (Alpha-2) ISO country code for the business's address.

businessLegalNamestring

The business's legal name.

billingContactFullNamestring

The business billing contact's full name.

billingContactPhonestring

The business billing contact's phone number. Must be 10 characters long and include only digits.

billingContactEmailstring email

The business billing contact's email address.

isApiUserboolean

Indicates whether the user has the API user role.

isEnabledAuthorizedStatusboolean

Indicates true when the account is configured to use "authorized" status. Indicates false when the account is configured to use "pending" status.

isEnabledForCybersourceAccountUpdaterboolean

Indicates whether the user is enabled for the Account Updater feature.

isEnabledForAccountUpdaterboolean

Indicates whether the user is enabled for the legacy version of the Account Updater feature.

rolestring

The user's custom role.

dateCreatedstring

The date and time at which the user was created, formatted as an ISO-8601 date expressed in UTC.

dateLastModifiedstring

The date and time at which the user was last modified, formatted as an ISO-8601 date expressed in UTC.

cognitoSubstring

For Nexio use only.

isEnabledForVTermboolean

For Nexio use only.

shouldShowPlatformAgreementboolean

For Nexio use only.

shouldShowPricingAgreementboolean

For Nexio use only.

Example response

{
  "userName": "jdoe@example.com",
  "accountType": "MERCHANT",
  "enabled": true,
  "firstName": "John",
  "lastName": "Doe",
  "phone": "15555555555",
  "address1": "2147 West Silverlake Drive",
  "address2": "Ste. 42",
  "city": "Scranton",
  "state": "PA",
  "postalCode": "18503",
  "country": "US",
  "businessLegalName": "[Business legal name]",
  "billingContactFullName": "John Doe",
  "billingContactPhone": "15555555555",
  "billingContactEmail": "jdoe@example.com",
  "accessRights": {
    "merchantIds": {
      "100039": "A"
    },
    "role": "A"
  },
  "payoutAccessRights": {
    "3927": "A"
  },
  "loginInfo": {
    "count": 5,
    "lastLogin": "2023-05-26T23:12:02.571Z"
  },
  "dateCreated": "2018-09-27T14:27:39.626Z",
  "dateLastModified": "2019-03-08T00:58:27.893Z"
}