Overview

Agent is an administrative role with restricted access. The main functionality of the role is creating new Person and Company profiles via the Administrative panel for and on behalf of a White Label. The most common use case is providing sales agents with an access to create profiles without ability to see the whole client base.

Opening the item

Follow the steps below to access an Agent profile:

  1. Navigate to the Admin Panel

  2. Click Administration on the left sidebar

  3. Go to the Administrators menu item.

  4. Click Filters in the top right corner and select the Role option from the drop-down list.

  5. Select Agent in the role field and click Filter.

  6. Click Show or Edit in a profile line to open its details

How to create an Agent profile

Due to dependency on a White label, an Agent profile requires additional configuration to define which White label it is related to. Thus, the profile creation is performed as follows:

  1. Create an Agent profile.

  2. Create an API key.

  3. Assign the API key to the Agent profile.

Once all the actions are performed, the Agent will be able to log in to the Admin Panel and create new Client profiles on behalf of the White label.

To create an Agent profile

  1. Navigate to the Admin Panel.

  2. Click Administration on the left sidebar.

  3. Go to the Administrators menu item.

  4. Click Add new to create a profile.

  5. Fill in the personal details dields including the following:

    1. First name.

    2. Last name.

    3. Email.

    4. Locale.

  6. Set the Enabled checkbox to activate the profile once it is created.

  7. Set the profile password in the Password and Repeat password fields. The credentials will be used for logging in to thew Admin Panel.

  8. Select an Agent access role for the profile from the Access Roles drop-down list. Only access roles without editing actions will be available for selection.
    For example, an access role with the following configuration will be shown in the drop-down list:

    1. Persons: List, Create, Show, and Export.

    2. Companies: List, Create, Show, and Export

    3. Transactions: List, Create, and Export

  9. Select the Agent role from the Role drop-down list.

  10. Click Create to confirm the profile creation.

To create an API key

  1. Navigate to the Admin Panel.

  2. Click API on the left sidebar.

  3. Go to the API keys menu item.

  4. Click Add new to create a new API key.

  5. Set the White label name in the Client field.
    The White label is to be registered as a Company in the Admin Panel.

  6. Fill the Allowed IPs field if you want to specify the computers the Agent will log in from. The field is optional.

  7. Set the API key Type to define whether it used for testing or production purposes.

  8. Set the Enabled checkbox to activate the key once it is created.

  9. It is also possible to define Access roles that can be used with the key. The field is optional.
    When creating an API key for Agents, It is recommended to leave the field empty and set an Access role within the Agent profile.

  10. Click Create to confirm the key creation.

To assign the API key to the Agent profile

  1. Navigate to the Admin Panel.

  2. Click Administration on the left sidebar.

  3. Go to the Administrators menu item.

  4. Click Edit in the line of the new Agent profile.

  5. Select the API key from the Agent companies drop-down list.

  6. Click Update to confirm the changes.

Component parameters

Parameter

Description

Id

The column demonstrates internal identification numbers assigned to Administrators.

First Name

First name of an Administrator.

Last Name

Last name of an Administrator.

Email

Email address of an Administrator. The parameter value is used as credentials

Role

Defines the type of an administrative profile:

  • Admin: an Administrator with limited access. This type of Administrators is mostly entitled to a specific functionality depending on the defined access roles. For example, an Administrator can access the Banking section, while the other sections remain unavailable. See Access roles (Administration) for details.

  • Super Admin: an Administrator with unlimited access within the Admin Panel. Such Administrators can access any section of the Admin Panel and entitled to create and edit Admin profiles.

  • Agent: a White label agent entitled to create new client profiles. See Agents for details.

Enabled

Defines whether the profile is active and can be used to access the Admin Panel.

Is Two Factor Auth Enabled

Defines whether the 2FA is enabled for the profile.

Action

  • Click Show to browse profile details.

  • Click Edit to change profile details.

Configuring the component

Parameter

Description

First Name

First name of an Administrator.

Last Name

Last name of an Administrator.

Email

Email address of an Administrator. The parameter value is used as credentials

Locale

Defines the location and language for the profile.

Enabled

Defines whether the profile is active and can be used to access the Admin Panel.

Password

Profile password. The credentials will be used for logging in to thew Admin Panel. Fill in the field with the new profile password when changing it

Repeat password

Fill in the field with the new profile password when changing it.

Access roles

Defines which access roles are assigned to the profile. Click the field and select an access role from the drop-down list. See Access roles (Administration) for details.

Access groups

Defines which administrative access groups assigned to the profile.

Role

Defines the type of an administrative profile:

  • Admin: an Administrator with limited access. This type of Administrators is mostly entitled to a specific functionality depending on the defined access roles. For example, an Administrator can access the Banking section, while the other sections are not available for them. See Access roles (Administration) for details.

  • Super Admin: an Administrator with unlimited access within the Admin Panel. Such Administrators can access any section of the Admin Panel and entitled to create and edit Admin profiles.

  • Agent: a White label agent entitled to create new client profiles. See Agents for details.

Agent companies

Defines the White label name on behalf of which the Agent accesses the Admin Panel. The functionality is enabled in the API keys section.