Users
- Miles Graves
When onboarding any entity onto the platform, a User is crucial for accessing the Portal and API. Users serve as a Portal login and a distinct identifier for each user in your business entity and overall portfolio. This grants you full transparency into business activities and the individuals driving them, ensuring unmatched security and visibility to manage risks effectively and empower your staff to carry out vital tasks on our platform.
User Structure
Users are made up of two major components, the user’s information and the roles assigned to that user:
User Info - Contact information to associate the user account with a real-world person.
User Roles - Settings that determine the capabilities of the user for that entity account.
These components provide the necessary information to quickly locate and communicate with platform users within your business and the functions they are capable of using through the Portal or API.
User Access Levels
A user's access level on the Portal is dictated by the entity level associated with their account. This means that a Merchant User will have access to Merchant capabilities, but not Referrer or Facilitator capabilities, whereas a Referrer can access both Merchant and Referrer capabilities and functions of the Portal (except directly accepting payments).
User Information
When an entity wants to add a new user, the user will need to provide some information, name, phone number, and email as examples, to get started. From here the user will be provided with a Role, username, and password associated with that information and tied to the entity that created the User. The steps below will demonstrate how to set up a new User with a login.
The following information is required to create a new user:
Required Information | Description | Notes |
|---|---|---|
Role | A comprehensive configuration template that defines the access privileges of a user to view, edit, create, or remove information within the Portal. | Valid Values:
|
Full Name | The full legal name of the user who the login is being created for. |
|
Username | The username for the new login. | Note: This field will be auto-generated from the text in the “Full Name” field. This can be modified manually if needed. |
Multi-Factor Authentication Enabled | Whether the user will need to enroll in Multi-Factor Authentication for a two-step authentication process during Portal login. | Note: It is recommended to enable this for all users for maximum risk mitigation. |
Password | The password that a new user will utilize alongside their username to access the Portal. | Recommended Requirements:
|
Phone | The phone number associated with the new user. | |
The email address associated with the new user. |
User Roles
During the user creation process, you select a Role for the user. A Role is a default configuration dictating a user’s ability to view, edit, create, or delete information. By assigning roles to users, access capabilities can be tailored to meet specific requirements effectively.
During setup, you can select one of the following default role types:
Default Role Types | Description | Example |
|---|---|---|
Admin Full Access | This level of access enables the user to view, edit, and manage all child entities, settings, and actions on the user’s entity account. | Enables a Facilitator-level user to easily view, edit, and manage their platform portfolio, including Referrers, Merchants, and account configurations. Allows actions like "login as" for comprehensive management. |
Admin View Only | This level of access enables the user to view child entities and data only for the user’s entity account. | Grants Referrer-level user access to the entity, data, and actions within their portfolio, enabling reporting and accounting functionalities. |
Full Access | This level of access allows a user to view and edit & manage all entities underneath the user’s entity account. | A Merchant-level user is empowered with various capabilities such as adding new customers, accepting payments, scheduling payouts, and more under their entity. |
View Only | This level of access allows a user to view only all entities underneath the user’s entity account. | Grants Merchant-level Users access solely to view transaction data and reporting information related to their entity, facilitating reconciliation processes. |
{Custom Access Template} | This role is a custom configuration of predefined roles and role resources being assigned to the user. | Grants a Merchant-level User access only to reporting features of the Portal to avoid confusion and mitigate internal risk for accountants of the Merchant’s business. |
Modifying Default User Roles
This option only allows the selection of templated user roles, to modify specific roles and role resources, you’ll need to create the User first with a Role template, then access the User Profile page to modify them individually.
User Management Use Cases
The use case tutorials outlined below can assist you in navigating the process of creating, modifying, and securing your users and their permissions on the platform: