Sign in
User Management

Create user

Creates a new user.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

Include at least the email address and value for the role of this new user.

<div style="display:none;">

Request parameters

  • email
  • role -merchantIds

Response parameters

  • message
</div>
post/user/v3/account/emvioUser

Request body

emailstring required

The new user's email address.

role'R' | 'W' | 'A' required

The new user's role. Determines their level of access.

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
merchantIdsstring[]

The merchant IDs the new user will be able to access.

Example request

{
  "email": "newuser@example.com",
  "role": "A",
  "merchantIds": [
    "000999",
    "100039",
    "100040",
    "100041"
  ]
}

Response

Success

userNamestring

The username for the account.

firstNameFirstName — unresolved $ref
lastNameLastName — unresolved $ref
phonePhone — unresolved $ref
enabledboolean

Set to true if the user is enabled.

rolestring

The user's custom role.

cognitoSubstring

The AWS Cognito user sub for this user.

isEnabledForVTermboolean

For Nexio use only.

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.

Changes

No recorded changes to this endpoint across all 1 revision of this API.