# Your Guide to PAVE's Account and Enterprise Dashboards

Welcome to 'Your Guide to PAVE's Account and Enterprise Dashboards.' 

This handbook is designed to help you navigate and make the most of PAVE's main enterprise dashboard and the dashboards associated with branch accounts in your organization.

To ensure ease of use, we've structured this guide with dedicated sections for each dashboard type and various user roles based on permissions. Consult the relevant table of contents to find the information that aligns with your needs and interests.<br>

[**Enterprise Dashboard:**](/enterprise-dashboard/permissions-and-access-settings)

* Administrators can use this dashboard to create user groups (branches) and individual branch accounts.
* They can grant access to specific parts of PAVE to different business units within their organization.
* You can track inspection sessions and retrieve condition reports.

[**Branch Dashboard:**](/branch-dashboard/overview)

* Each account created in the Enterprise Dashboard has its branch dashboard.
* Unlimited users can be added to each branch dashboard, with specific roles for administering settings and users.
* You can initiate inspections, create widgets (like shareable links for photo capture during inspections), and more.

Whether you're new to PAVE or an experienced administrator, this handbook provides valuable insights to help you manage access and collaborate seamlessly using these dashboards.


# Permissions and Access Settings

First, let us review the permissions and access settings in the Enterprise Dashboard, specifically for Administrators like yourself. Understanding these permissions is essential, as they determine what you can do and how much control you have. By the end of this section, you'll grasp your roles and responsibilities as an Administrator within the Enterprise Dashboard and the features available to you in this guide.

Explore each permission page for a deeper dive into how each feature operates.

<figure><img src="/files/NGMcHWpQA5XkhCyzOEp9" alt=""><figcaption></figcaption></figure>

| Permission Setting:                                                                                                   | Access Granted:                                                                                                                                                                         |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [View All Groups](/enterprise-dashboard/user-feature-walkthrough/view-all-groups)                                     | If selected, this admin user can search, export and view all sessions for any group’s accounts. When not selected, this will open a dropdown to provide access to only selected groups. |
| [Group Manage](/enterprise-dashboard/user-feature-walkthrough/group-manage)                                           | If selected, this admin user will be able to create new groups.                                                                                                                         |
| [Group Remove](/enterprise-dashboard/user-feature-walkthrough/group-remove)                                           | If selected, this admin user can remove/delete groups.                                                                                                                                  |
| [Account Manage](/enterprise-dashboard/user-feature-walkthrough/account-manage)                                       | When activated, this admin user can create and edit accounts (Branch Dashboards) for any group they are granted to view.                                                                |
| [Account: Switch To](/enterprise-dashboard/user-feature-walkthrough/account-switch-to)                                | This setting allows the admin user to switch in and out of any account (Branch Dashboard) within the group to which they have viewed access.                                            |
| [Administrator: Manage](/enterprise-dashboard/user-feature-walkthrough/administrator-manage)                          | This setting allows this admin user to create and edit other admin users.                                                                                                               |
| [Data: Manage](/enterprise-dashboard/user-feature-walkthrough/data-manage)                                            | This setting allows the admin user to access and edit the ‘Batches’ and ‘Exports’ functionality as well as generate and download the Session Files CSVs                                 |
| [Data: Export Only](/enterprise-dashboard/user-feature-walkthrough/data-export-only)                                  | This setting allows the admin user to generate and download Session Files CSVs only.                                                                                                    |
| [Data: Developer](/enterprise-dashboard/user-feature-walkthrough/data-developer)                                      | This setting allows the admin user to access, create, and manage API keys at an Enterprise Level that can be linked to any branch accounts inside this enterprise account.              |
| [Initiate Inspections](/enterprise-dashboard/user-feature-walkthrough/initiate-inspections-coming-soon) (coming soon) | This setting allows the admin user to initiate inspections to each branch account by uploading a list of VINs.                                                                          |


# User Feature Walkthrough


# View All Groups

If selected, this admin user can search, export and view all sessions for any group’s accounts to which they have been granted access.&#x20;

<figure><img src="/files/WAAAl2xiVOuzvuqricNx" alt=""><figcaption></figcaption></figure>

Navigate to the GROUPS section after logging into your Enterprise account with your credentials. Look for the ordered list icon in the provided list next to the groups you've been granted access to.

<figure><img src="/files/5JizEpufv2O54cn6UY8T" alt=""><figcaption></figcaption></figure>

To better understand how to navigate reviewing or exporting sessions from each of the groups or individual branch accounts, please take a look at the following pages.

&#x20;


# Filtering Sessions

<figure><img src="/files/qKRjyicLCkAkLhVNVkly" alt=""><figcaption></figcaption></figure>

You can refine your session search by choosing specific options from the following dropdown filters:

* Group
* Branch Account
* Month
* Status


# Searching Sessions

To find specific inspections, you can use the keyword search. This feature lets you enter the VIN, Session ID, vehicle year, make, and model to quickly retrieve your desired results.

<figure><img src="/files/Gbjsx2EV2toR7iPSvSGv" alt=""><figcaption></figcaption></figure>


# Advanced View

To access the 'Advanced View,' toggle the switch in the page's upper right corner. This view displays the captured photos, and for real-time monitoring of end users' progress, use the 'Live View' option.

<figure><img src="/files/NMVH3Lj8KYdwzbY4WJx8" alt=""><figcaption></figcaption></figure>


# Exporting Sessions

To export sessions, follow these steps:

1. Choose the group, the accounts, and the month you want to export.
2. Click the green 'PROCESS EXPORT' button.
3. Wait for the export notification to vanish.
4. Click on the 'VIEW EXPORT FILES' button.
5. From the list, select your export and download the generated CSV file.

<figure><img src="/files/JxXNIrb5IN5ZQD7tmL7D" alt=""><figcaption></figcaption></figure>


# Group Manage

Now that we've explored how to view all groups let's delve into the process of creating and managing them.

Within PAVE, you can manage groups, efficiently providing your organization with valuable flexibility. This functionality allows you to segregate sessions among different sets of branch accounts, serving various purposes. Whether you need to organize individual branch accounts for distinct business units or providers or you're looking to categorize sessions based on specific use cases under a single branch account within a particular group, PAVE offers you the tools to achieve these objectives.

<figure><img src="/files/KmuM8nY6h06mklTIhHLe" alt=""><figcaption></figcaption></figure>


# Create New Group

\
To create a new group, follow these steps:

1. Navigate to the GROUPS section on your dashboard.
2. Click on the green "+ CREATE NEW GROUP" button.
3. Provide a name and description for your new group.
4. If this group operates in a region different from your account's original country, utilize the DEFAULT GROUP REGION option. This choice enables PAVE to tailor services such as SMS messaging, translations, and VIN lookups to that specific region.
5. You can select the EXPORT SETTINGS that best suit your needs if you have established multiple custom export settings.
6. Now, you can add or create branch accounts to your newly created group.

<figure><img src="/files/0p6Xq6NTbk8gAGppExCL" alt=""><figcaption></figcaption></figure>


# Add Accounts to Group

Now, learn how to add a branch account to your newly created group.

<figure><img src="/files/QivyEusqic7TRD04LOBa" alt=""><figcaption></figcaption></figure>

1. Go to the ACCOUNTS section.
2. Locate the account you want to add to a group.
3. Click on the pencil icon to edit the branch account details.
4. On the bottom left, find the ACCOUNT GROUP field.
5. You can choose the group to add the account from the dropdown menu.
6. Click "SUBMIT & CLOSE" to save your changes.


# Edit Group

\
To edit the settings for a group, follow these simple steps:

1. Go to the GROUPS section of your dashboard.
2. Locate the group you wish to edit and click on the pencil icon next to it.
3. Make the desired changes.
4. Click on "SUBMIT" to save your edits.

<figure><img src="/files/ULIpk5KLiNuIT5VPvsEW" alt=""><figcaption></figcaption></figure>


# Group Remove

To remove a group, follow these steps:

1. You can go to the GROUPS section of your dashboard.
2. Find the group you want to remove and click on the red "x" icon next to it.
3. Confirm the removal of the group.

So that you know, removing the group will not deactivate the associated accounts. These accounts will remain active and can be found under the ACCOUNTS section. You can add these accounts to a different group or create a new one as needed.

<figure><img src="/files/wnnydxDhlZ38ghbV9Zro" alt=""><figcaption></figcaption></figure>


# Account Manage

Within your Enterprise dashboard, you have the power to create and oversee an unlimited number of branch accounts, which play a pivotal role in initiating PAVE inspections. These accounts offer a wide range of independent functionality, which we'll delve into in more detail in the Branch Dashboard section. But before we get there, let's begin by exploring how to create and manage these accounts.

<figure><img src="/files/VJl4iNcohrrRYeAQrdTj" alt=""><figcaption></figcaption></figure>


# Create New Account

{% hint style="danger" %}
Before we create a new account, let's determine how we'll manage access to the account settings and who should have complete control over them. Ideally, only enterprise administrators with 'Account Management' access should possess these high-level permissions for the newly created account. We would recommend that you don't share credentials with anyone during the initial account setup. Instead, you can add individuals as users within the newly created account and assign them specific roles with permission settings tailored to their responsibilities.

Review the [User Account Permissions](/enterprise-dashboard/user-feature-walkthrough/account-manage/add-user-to-new-account/user-account-permissions) section to learn more.
{% endhint %}

\
To create a new branch account, follow these steps:

1. Go to the ACCOUNTS section.
2. Click on the "+ CREATE NEW ACCOUNT" button.
3. Provide a unique username for the new account.
4. If you're not sending credentials to anyone, use your email address for now.
5. Enter a password or use the green icon to generate one.
6. Choose the group in which you want to place this branch account.
7. Input the full business name of the account.
8. Select the appropriate region if the account is located outside your primary account's country.
9. Optionally, you can enter the contact name and phone number of the primary account holder.
10. Toggle to have PAVE send credentials to the end user you entered, or leave it off to ensure no credentials are sent.
11. Click "SUBMIT & CLOSE" to save your changes.

<figure><img src="/files/EjJSb1DBJbQGBFWbnH5m" alt=""><figcaption></figcaption></figure>


# Add User to New Account

Since we've chosen not to send full access credentials for the newly created branch account and prefer to create a specific user instead, we'll skip ahead to understanding how to use the 'Account: Switch to' feature if you have the necessary permission to add a new user to this account.

<figure><img src="/files/BDMARKTtpt3pCjTNC5W4" alt=""><figcaption></figcaption></figure>

You can go to ACCOUNTS, find the newly created account, and click the green switch icon to gain full access to this account.&#x20;

<figure><img src="/files/l2MzlucFfrkoKTLkHqO3" alt=""><figcaption></figcaption></figure>


# User Account Permissions

Before adding a new user to this account, let's take a moment to review the permissions associated with each user role, detailing what each role allows users to perform. The following table overviews any branch account's available permissions and capabilities.

| Permission Setting:       | Access Granted:                                                                                                                                                                                                                                                |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SESSIONS.DASHBOARD        | This permission allows the user to search and view all sessions for any user. If you wish to limit their access to specific sessions, consider assigning them the 'User' role instead, where you can specify the sessions they can access using API Keys.      |
| SESSIONS.FILES            | This permission enables the individual to export and download session files in CSV format.                                                                                                                                                                     |
| DEVELOPER.API.KEYS        | When this permission is granted, the individual can create, modify, and oversee API keys tailored for developers. Furthermore, they can manage distinct use case flows, each customizable to serve specific purposes.                                          |
| DEVELOPER.API.LOGS        | This setting is for your developers, who can track any API logs.                                                                                                                                                                                               |
| DEVELOPER.SESSIONS-EVENTS | This setting is also for your developers, who can track all session events.                                                                                                                                                                                    |
| DEVELOPER.WEBHOOKS        | This is also a developer setting to allow them to set up webhooks.                                                                                                                                                                                             |
| SETTINGS.ACCOUNT          | This permission allows the user to edit primary account settings, such as the email address, and change the primary account's password.                                                                                                                        |
| SETTINGS.BRANDING         | This permission provides the user with the capability to customize branding on the capture user interface and condition reports by incorporating custom logos, videos, and brand ID colors. Additionally, this user can personalize the messages sent via SMS. |
| SETTINGS.USERS            | This permission allows for creating, editing, and managing other user accounts.                                                                                                                                                                                |
| SETTINGS.WIDGETS          | This permission grants access to PAVE widgets, such as shareable links or embeddable website forms. Users with this permission can create and edit these widgets as well.                                                                                      |
| SETTINGS.BATCHES          | This permission is intended for individuals who may need to set up FTP/SFTP batches for their sessions.                                                                                                                                                        |
| SETTINGS.ESTIMATES        | This setting enables a person to edit and manage the costs associated with any PAVE estimations within this account, including the hourly rate.                                                                                                                |
| SETTINGS.INTEGRATIONS     | This setting allows the person to manage any available third-party integrations with PAVE, such as vAuto.                                                                                                                                                      |
| SETTINGS.CUSTOM-CAPTURE   | Custom Capture enables a person to create custom questions and additional photo capture steps that can be incorporated alongside the default PAVE capture steps.                                                                                               |
| DISPUTES.DASHBOARD        | (Coming soon) This feature will enable this person to create and manage session damage disputes.                                                                                                                                                               |


# Edit Account

To edit a branch account, follow these steps:

1. Navigate to the ACCOUNTS section.
2. You can find the account you want to edit and click on the pencil icon next to it.
3. Make any necessary changes to the account details.
4. If you change the password and wish to send it to the account holder, toggle the "Send password to the associated email address."
5. Click "SUBMIT & CLOSE" to save your changes.

<figure><img src="/files/RVuDZqAETyJgABOrNNOx" alt=""><figcaption></figcaption></figure>


# Deactivate Account

To deactivate an account, follow these steps:

1. Go to the ACCOUNTS section.
2. Click the pencil icon next to the account you wish to deactivate.
3. Find the "DEACTIVATE ACCOUNT" option in the top right-hand corner.
4. Select "SUBMIT & CLOSE" to save the changes.

To reactivate the account, repeat these steps and click "ACTIVATE ACCOUNT."

<figure><img src="/files/P03m0TiFL2dj4rwmmV5X" alt=""><figcaption></figcaption></figure>


# Account: Switch To

The 'Account Switch To' feature provides comprehensive access to any account, allowing you to execute a wide range of functions. This encompasses tasks such as creating and administering individual user accounts, adjusting estimation tables, configuring API keys and widgets, and much more. For additional information, please consult the section on branch account dashboards.

<figure><img src="/files/qNZcnI9WGKoCCKu57uE1" alt=""><figcaption></figcaption></figure>

\
To switch to any account, follow these steps:

1. Navigate to the ACCOUNTS section.
2. Click the green "switch to" icon next to the account you want to access.
3. When you're finished using this account, click the "SWITCH BACK" link in the top right corner of the dashboard to return to your original account.


# Administrator: Manage

As an Administrator with 'Administrator: Manage' permissions, you can create and oversee an unlimited number of Administrator user accounts. This section will guide you through adding and managing these users. Please take a look at the screenshot below to familiarize yourself with this Enterprise dashboard section.

<figure><img src="/files/AGNLF4lOJVCepWzrVcgQ" alt=""><figcaption></figcaption></figure>


# Create New Administrator

{% hint style="info" %}
Before we proceed with adding a new user, please take a moment to familiarize yourself with the Enterprise Administrator permissions outlined in this section:

[Permissions and Access Settings](/enterprise-dashboard/permissions-and-access-settings)
{% endhint %}

To add a new administrator to your enterprise dashboard, follow these steps:

1. Navigate to the ADMINISTRATOR section.
2. Click on the green "+ CREATE NEW USER" button.
3. Enter the user's information.
4. To generate a system password, click the green icon next to the password field.
5. Slide the toggle to have PAVE send the user their credentials via email.
6. Use the permission toggles to select the appropriate access.
7. Click the "SUBMIT" button to save your changes.

<figure><img src="/files/Of0Wf30cnF97jBzS3eeD" alt=""><figcaption></figcaption></figure>


# Edit Administrator

To edit an administrator user, follow these steps:

1. Go to the ADMINISTRATORS section.
2. Locate the user you wish to edit and click the pencil icon next to their name.
3. Make any required modifications to the account information.
4. If you've updated the password and want to send it to the account holder, enable the "Send password to the associated email address" option.
5. Finally, click "SUBMIT & CLOSE" to save your changes.

<figure><img src="/files/UGj36MOM7qBgb3XjFTQX" alt=""><figcaption></figcaption></figure>


# Administrator: Switch

The "Administrator: Switch" function allows administrators to seamlessly switch between different administrator user accounts, allowing them to verify and adjust the user's dashboard view during account setup, editing, and support purposes. Only administrators with "Administrator: Manage" permissions should use this feature.

<figure><img src="/files/IRCLugWoRoc0UoaA4vYh" alt=""><figcaption></figcaption></figure>

\
If you have the necessary permissions, here's how you can use the "Administrator: Switch" feature:

1. Navigate to the ADMINISTRATORS section in your dashboard.
2. Locate the user account you wish to switch to.
3. Click the green switch icon to enter their account view.
4. When you're finished working within their account, click the "SWITCH BACK" link located in the top right corner of your dashboard screen to return to your own account view.


# Data: Manage

The 'Data: Manage' setting allows the admin user to access and edit the ‘Batches’ and ‘Exports’ functionality as well as generate and download the Session Files CSVs\
\
With this permission turned ON, Admin users have access to the following features on their enterprise dashboard as shown below:

<figure><img src="/files/4vmnyXnTZBZhkELD7tdb" alt=""><figcaption><p>Session Exports</p></figcaption></figure>

<figure><img src="/files/t5dgpL2NCAHiPyeyXSAj" alt=""><figcaption><p>Batches and Exports</p></figcaption></figure>

#### You can read about these features in detail here:

[How to generate and download a Session File](/enterprise-dashboard/user-feature-walkthrough/data-export-only#how-to-generate-and-download-a-session-file)

[Creating a New Export Setting](/enterprise-dashboard/user-feature-walkthrough/create-new-export-setting)

[Setting up SFTP Batches](/enterprise-dashboard/user-feature-walkthrough/setting-up-sftp-batches)


# Data: Export Only

The 'Data: Export Only' permissions allow Admin users to generate and download Session Files as CSV for a given group's sessions. \
\
With this permission turned ON, Admin users can see the following features on their enterprise dashboard as shown below:

<figure><img src="/files/pHBGFPHL63Jab2AsOpid" alt=""><figcaption></figcaption></figure>

### How to generate and download a Session File.

This section highlights how to generate and download a Session File.

<figure><img src="/files/dimM7Oa9jvSZ3hWcBynx" alt=""><figcaption><p>Step 1: Select Group</p></figcaption></figure>

<figure><img src="/files/BVPKqa4FpK6OUs1MeDSx" alt=""><figcaption><p>Step 2: Select the Account and Month, and click 'Process Export'</p></figcaption></figure>

<figure><img src="/files/xAtEmOgC7RY0xUuWx7w9" alt="" width="261"><figcaption><p>Step 3: Click 'Submit'</p></figcaption></figure>

<figure><img src="/files/F71F9iXiEiZF3sx4lNIZ" alt=""><figcaption><p>Step 4: 'Click on 'View Exported Files'</p></figcaption></figure>

<figure><img src="/files/ZBxz1f5xG5AQyExWPgZI" alt=""><figcaption><p>Step 4: Click the 'File Name' to download the Session File as a CSV</p></figcaption></figure>


# Data: Developer

The "Data: Developer" setting allows admin users to access, create, and manage API keys at an Enterprise Level that can be linked to any branch accounts inside the enterprise account.

By managing API keys at the Enterprise level, you can quickly and easily make adjustments that cascade down to your branch accounts.

**How to Create a new API key**

<figure><img src="/files/YarD4i3zXOXqPyul9krO" alt=""><figcaption><p>Step 1: Click CREATE NEW KEY</p></figcaption></figure>

<figure><img src="/files/VKygzz51YhqwWqesPXHq" alt=""><figcaption><p>Step 2: Configure the settings of your new API key</p></figcaption></figure>

KEY NAME: This will be the name that appears for selection when creating widgets, shareable links, and in your data exports.

LIVE (toggle): This setting allows a user to enable or disable a key after it has been created.

LICENSE: Select the appropriate license for the key you want to create.  Licenses can be used to manage customized capture sequences and other settings.&#x20;

DEFAULT THEME: This toggle allows you to select the LITE or PRO capture theme for the API key.   &#x20;

PII MASK: This setting enables the blurring of license plates and human faces, and the removal of the VIN photo from the dashboard

SUPPORTED LANGUAGES: This setting allows you to set English or French as your default language for inspections.

REDIRECT URL: You can enter a custom redirect URL that will appear at the end of the capture sequence. If left blank, the default page will appear.

EXPIRED SESSIONS: This setting determines the age at which incomplete sessions expire.

CAPTURE OPTIONS: Capture sequences can be customized to include or exclude elements using the checkboxes.&#x20;

NOTIFICATIONS: You can customize the text in the SMS messages used to launch inspections and return condition reports.

WEAR & TEAR ESTIMATES: This setting allows you to show repair estimates or not in the condition reports that are associated with the API key.

<figure><img src="/files/dud0tJQxyBuLDVa37p20" alt=""><figcaption><p>STEP 3: Click "CREATE" once all settings are configured</p></figcaption></figure>


# Initiate Inspections (coming soon)

This feature allows for selective permission assignment to users for initiating inspections to each branch account by uploading a list of VINs.


# VIN Assignment

This section explains the 'VIN Assignment' feature that allows the assignment of specific VINs to the Branch Accounts and shows the completion of inspections for such VINs on the Enterprise Dashboard

{% hint style="info" %}
**Optional Feature**: This feature may not appear on your dashboard. \
Please email us at <product@pave.ai> if you do not see this feature and wish to add it to your account."
{% endhint %}

## How to navigate the 'VIN Assignment' feature

### Step 1:  Access the feature on the Enterprise Dashboard

After logging into your Enterprise dashboard, access the new feature by navigating to 'Settings' and then 'VIN Assignment' as shown below

<figure><img src="/files/YCjF8XeM5bLNmQ0Brtsw" alt=""><figcaption><p>VIN Assigment Feature</p></figcaption></figure>

### Step 2:  VIN Assignment Purpose Codes

The first step to activate this feature is to set up the purpose codes to define fields that capture the inspection information necessary to specify the inspection's purpose and completion timeframe. Begin by clicking on the 'NEW PURPOSE CODE' button.

<figure><img src="/files/jmh9D3Cnl3no9NCmhgr7" alt=""><figcaption><p>Select 'New Purpose Code'</p></figcaption></figure>

<figure><img src="/files/QeFnN8y98r9kGbdb8Xmr" alt=""><figcaption><p>Configure the new Purpose Code</p></figcaption></figure>

These purpose codes are a field within the VIN upload template which indicate the information needed to know:&#x20;

* Which included code relates to each VIN that is included in the uploaded file
* What the Purpose or “Inspection Type” relating to each VIN is
* In how much time does the assignment have to be completed in based on the Purpose Code.

#### Temporary VIN Assignment:

Activating this feature assigns that VIN to a specific user account name specified in the file upload. \
\
Selecting this will make the Account Username a mandatory field for each assignment that has this Purpose code associated.

### Step 3: Download Assignment Template

Download the CSV template after adding your purpose codes to facilitate populating test data. This will allow you to simulate the assignment of VINs to specific accounts for inspections tied to the designated Purpose Code.

<figure><img src="/files/F9sXykCMmo2yOsrucQYp" alt=""><figcaption></figcaption></figure>

### Step 4: Populate the template with a VIN and Account for the assignment<br>

Enter the VIN of the vehicle you want to test in the PAVE Branch Account and the Purpose Code to assign the test date. Also, specify the account name from which you wish to conduct the test, which will receive the assignment once uploaded.

<br>

<figure><img src="/files/2oYRnqVA4t4xgil334oP" alt=""><figcaption><p>CSV Teamplate with Sample Values</p></figcaption></figure>

### Step 5: Upload the Saved CSV File

To upload the file, go to the 'VIN Assignment' section and click 'Upload Inspection Assignment', as shown below.&#x20;

<figure><img src="/files/BHSsvZG5teXmG3V5Kb4n" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/C6ptQ4yOUG6mGhKz9ZfM" alt=""><figcaption></figcaption></figure>

Upon successful upload, the screen will display the following confirmation.

<figure><img src="/files/bLX1W52iFbRbw7wz4bUg" alt=""><figcaption><p>Successful CSV Upload</p></figcaption></figure>

{% hint style="info" %}
If the assignment validation fails, follow the error prompts to identify the issues, adjust your CSV file accordingly, and then reattempt the upload.
{% endhint %}

{% hint style="success" %}
As the next step, the Branch account user can then see this VIN assignment on their Branch dashboards and complete the inspection for these VINs. \
[Read more here](/branch-dashboard/user-feature-walkthrough/vin-assignments)
{% endhint %}


# Create New Export Setting

You can create custom export settings as an administrator with access to view sessions for a specific group. When using the export feature, these settings allow you to configure the specific session data you want to include in a CSV file. This customization gives you greater control over the exported data to meet your specific needs and requirements.

<figure><img src="/files/tb350Ef4xdOmkp9jqSH9" alt=""><figcaption></figcaption></figure>

To begin exploring this feature, follow these steps within your enterprise dashboard:

1. Locate the SETTINGS section on your screen.
2. Within SETTINGS, find the EXPORTS option.
3. Click on the green "+ NEW EXPORT SETTINGS" button to create custom export settings for your session data.

<figure><img src="/files/haHlUBSDXi3Rg9THen8a" alt=""><figcaption></figcaption></figure>

&#x20;\
After clicking the "+ NEW EXPORT SETTINGS" button and accessing the export settings, you should:

1. Give your Export Setting a name to identify it easily.
2. You will now have the option to choose between making this export setting the default setting, which will change the format used for exports within the dashboard, or leaving it as an optional export setting that can be selected when setting up FTP/SFTP batch exports.

Choose the option that best suits your needs based on whether you want to change the default export format or keep it as an alternative option for FTP/SFTP batch exports.

<figure><img src="/files/4jxzVETC3EIvCzk64uCe" alt=""><figcaption></figcaption></figure>

To populate the attributes you want in your export from the optional list of session data, follow these steps:

Inside your custom export settings, you'll see a list of available attributes or data points you can include.

To add an attribute to your export, click the green plus icon next to that attribute. This action will include the selected attribute in your export file.

If you see options labelled "object," selecting any options will add nested JSON within your file, including all the payload data related to each object.

Using the green plus icon, you can selectively include the specific data attributes you need for your export, ensuring that your exported file contains the desired information.

<figure><img src="/files/DnOfnYZS5CABwNVKErZM" alt=""><figcaption></figcaption></figure>

Once you've selected all the attributes you want in your CSV export, you can customize the order in which the columns will appear by following these steps:

1. You'll see the list of your selected attributes on the right side of your screen.
2. To rearrange the order of the columns, use the up and down icons next to each attribute in your selections.
3. Click the up or down icon to move an attribute higher or lower in the list. This will determine the order in which the columns appear in your exported CSV file.

By rearranging the attributes, you can ensure that the columns in your CSV export are organized according to your preferences and requirements.

Now click SAVE & EXIT and your new export is ready to use.


# Edit Export Settings

<figure><img src="/files/XSvV0b1rXZ5QUosnxUDq" alt=""><figcaption></figcaption></figure>

You have the flexibility to manage your export settings easily. Here's how:

1. To edit any of your existing export settings, go to the SETTINGS section and then navigate to the EXPORTS section.
2. Locate the export setting you wish to modify and click on the "EDIT" option. This will allow you to make the necessary modifications to the selected export settings.
3. If you want to create a new export setting that's similar to an existing one to save time, you can use the "CLONE" option. This will duplicate the settings and allow you to make any needed adjustments.
4. If you wish to remove an export setting, select the setting you want to delete and click on the "DELETE" button. This action will permanently remove the selected export setting.

These options provide you with the flexibility to fine-tune your export settings or manage them efficiently as needed.


# Setting Up SFTP Batches

\
You have multiple options for capturing data from your inspections using PAVE:

1. **API and Webhooks**: You can utilize PAVE's robust API and Webhooks to integrate inspection data into your systems seamlessly. This allows for real-time data capture and immediate processing.
2. **SFTP Option**: You can use the SFTP (Secure File Transfer Protocol) option for specific scenarios. You can configure this directly from your enterprise dashboard, enabling you to schedule and transfer inspection data at your convenience.
3. [**API Documentation**](https://docs.paveapi.com/): Refer to PAVE's API documentation to explore additional methods of integrating PAVE data into your systems. This documentation will provide comprehensive information on various integration options and techniques.

You can select the method that aligns best with your specific needs and system requirements to capture and utilize inspection data efficiently.

<figure><img src="/files/yoQuGPEGVbN0gqTqI3jj" alt=""><figcaption></figcaption></figure>

Before you start setting up your first SFTP batch, let's walk through the process by navigating to the SETTINGS and BATCHES sections. Here's what you need to do to familiarize yourself with the information required:

1. Go to the SETTINGS section in your enterprise dashboard.
2. Within SETTINGS, find the BATCHES option and click on it.
3. Look for the green "+ CREATE NEW BATCH" button and click on it to set up a new batch.
4. In the batch creation process, you will likely encounter options related to FTP (File Transfer Protocol). You can use the FTP toggle switch to understand the information you'll need to configure for SFTP-based batch transfers.

By following these steps, you'll be able to get the necessary details and settings for setting up your SFTP batch effectively.

Determining whether your SFTP endpoint requires only a password, an SSH private key, or both is a critical step in setting up your SFTP batch. Here's how to assess this:

1. **Password**: If your SFTP server is configured to accept authentication through a username and password combination, you will need the SFTP username and password to establish the connection.
2. **SSH Private Key**: If your SFTP server uses SSH key-based authentication, you will need to generate an SSH key pair. This pair typically consists of a private key (which you keep confidential) and a public key (which you provide to the server). Your SFTP server's administrator can guide you on how to upload or configure your public key for authentication.
3. **Both**: Some SFTP servers may offer the option to use either a password or an SSH private key for authentication. In such cases, you can choose the method that aligns with your security and access requirements.

Please consult your SFTP server's documentation or contact your system administrator to figure out the authentication method needed for your specific SFTP endpoint. This information is crucial for a successful setup of your SFTP batch.

<figure><img src="/files/elbEydt9vLxH4sNnrHiO" alt=""><figcaption></figcaption></figure>


# Dashboard


# Inspection Status

Monitor the status of inspections using visual cues

Status Codes

Once an inspection is created, it can hold one of the following statuses, and the inspection status can be easily identified by the icon placed on the top left of each listed inspection module.

#### IDLE

In the IDLE Status, the inspection link has been generated and the session is yet to start

<figure><img src="/files/xO06cazGaAsU6rXLihwD" alt=""><figcaption><p>IDLE Status</p></figcaption></figure>

#### STARTED

In the STARTED status, the user has started the inspection by clicking the 'GET STARTED' icon on the Capture UI, but has not yet captured any images

<figure><img src="/files/Uj6RfkB2rS3gYY8jGVos" alt=""><figcaption><p>STARTED Status</p></figcaption></figure>

#### PROCESS

In the PROCESS status, the user has started capturing the vehicle photos and the inspection is now in process

<figure><img src="/files/lR6NCyrKJpPHrNdjdPj3" alt=""><figcaption><p>PROCESS Status</p></figcaption></figure>

#### CAPTURED

In the CAPTURED status, all the session images have been captured and accepted by the PAVE inspection engine. Now, the PAVE inspection engine starts detecting the damages.

<figure><img src="/files/6Ww0kPZJs4Jz0KAZGoER" alt=""><figcaption><p>CAPTURED Status</p></figcaption></figure>

#### WAITING CONFIRM

In the WAITING CONFIRM status, the PAVE inspection engine has completed the inspection process and is awaiting the Condition Report to be generated.

<figure><img src="/files/l1Y1nQfCpBzhzQIn2NVH" alt=""><figcaption><p>WAITING CONFIRM</p></figcaption></figure>

#### COMPLETE

In the COMPLETE status, the Condition Report for the session has been generated as a PDF and the session is now complete.

<figure><img src="/files/6biIkEo3NBEHBALQwx7H" alt=""><figcaption><p>COMPLETE Status</p></figcaption></figure>

#### INVALID

Sessions are set to INVALID status when they have the required photos but PAVE cannot complete the inspection do to a mismatch between the VIN and 1 or more photos captured in the sequence.

<figure><img src="/files/i0nVGih0g7ucxbhh6ppp" alt=""><figcaption><p>INVALID Status</p></figcaption></figure>

#### EXPIRED

Sessions that are not yet complete can be set to 'expire', which then prevents those sessions from processing any further. You can read more about this feature [here](/branch-dashboard/user-feature-walkthrough/inspection-status/expired-sessions).

<figure><img src="/files/rDOycOQkhnZ9WqMnAaTK" alt=""><figcaption><p>EXPIRED Status</p></figcaption></figure>


# Session Exports

This guide highlights the Session Exports functionality for Enterprise dashboards, that allows users to download session reports seamlessly from their PAVE Enterprise dashboard.

## Steps to Navigate the Session Exports feature

### Step 1: Open the Dashboard view of the Enterprise Dashboard<br>

After logging into your Enterprise Dashboard, Select “Dashboard” and then select the Group for which you'd like to review/download sessions.

<br>

<figure><img src="/files/0hnTLPT8NBsaZD9Optzw" alt=""><figcaption><p>Click on 'Please slect a group' to select the appropriate group</p></figcaption></figure>

### Step 2: Select the desired account and timeframe

Inside this selected group, you can also further shortlist a single account. Otherwise by default, all accounts inside that group are selected.

Timeframes can be selected by specific month or all months.  The selected timeframe will determine which sessions are included in the export.

Then, click 'Process Export'<br>

<figure><img src="/files/5xzPsBpBw0RqDdeb1t4b" alt=""><figcaption></figcaption></figure>

### Step 3: Launch the Export Sessions dialogue  <br>

Clicking process export will launch the export configuration dialogue

{% hint style="info" %}
**Coming Soon:** The 'STATUS' checkbox for 'Export Sessions' is coming soon in April 2024
{% endhint %}

<figure><img src="/files/16bSJIiL3jtKGdYNIjs7" alt="" width="375"><figcaption><p>Select the different statuses and export types you'd like to be added to the report</p></figcaption></figure>

Select the desired session statuses to include in the export and the template you wish to use.  Then click 'Export X Sessions' to trigger the export.&#x20;

Template management is only available for those with [Data: Manage permissions.](/enterprise-dashboard/user-feature-walkthrough/data-manage)

{% hint style="success" %}
You can read further about creating a new 'Export Setting' [here](/enterprise-dashboard/user-feature-walkthrough/create-new-export-setting)
{% endhint %}

### Step 4: Download the export file

Click on 'View Exported Files' and find the generated file - this might take a few minutes.

**Sample file name:** *PAVE\_ExportRequest\_Group1\_2024-04\_1712840679.csv*

<figure><img src="/files/foeodvoZGw37Osi5evZ9" alt=""><figcaption><p>View Exported Files</p></figcaption></figure>

<figure><img src="/files/3yEzJqffd1ht93Hknbxx" alt=""><figcaption><p>Click the file to download as CSV</p></figcaption></figure>

### Status Codes

Once an inspection is created, it can hold one of the following statuses:

{% hint style="info" %}
**Idle** - Inspection has been received by the user but not opened&#x20;

**Started** - The user has started the inspection but has not yet captured any pictures

**Process** - The user has started capturing but has not yet completed the capture process.

**QC Passed** - All the images have been captured by the user and accepted by PAVE capture engine

**Confirm** - User confirmation on detected damages is awaited. \
*For PRO inspections only*&#x20;

**Complete:** Inspection is complete

**Invalid**: All photos have been captured but the session cannot complete because one or more of the photos doesn't match the VIN or a photo is not suitable for inspection.

**Expired**: Session has [expired ](/branch-dashboard/user-feature-walkthrough/inspection-status/expired-sessions)and cannot be captured or processed further.
{% endhint %}


# Custom Capture

**Custom Content-Driven Photos**

The Custom Capture feature allows users to set up their desired custom content-driven photo capture flow based on their requirements for any specific API key within their account.&#x20;

If selected, this would add this customized capture flow to the end of the inspection capture process. The client can create an unlimited number of these flows that they can attach to any specific API key.

**Step 1: Activation on Your Account**

First, the feature must be activated for your Enterprise account. Please ask your Client Support Manager to activate this feature to your account.<br>

**Step 2: Setting up a Custom Capture Flow**

<figure><img src="/files/rLjJjl2EQQToT6dcIKc4" alt=""><figcaption></figcaption></figure>

**PAVE Dashboard**&#x20;

To use this feature on the PAVE dashboard,  select the "CUSTOM CAPTURE" section inside "SETTINGS"

#### Video Tutorial on setting up a Custom Capture Questionaire.&#x20;

{% embed url="<https://www.youtube.com/watch?v=yLMRxsANkf0>" %}

<figure><img src="/files/cToGzi6qsORGQesaAZQH" alt=""><figcaption></figcaption></figure>

| Question Type | Description                                                                                          |
| ------------- | ---------------------------------------------------------------------------------------------------- |
| Yes/No        | Design a True or False response, and ask for a photo depending on the response, if required          |
| Text Entry    | The user is provided a text box to input their answer, and a photo attachment can also be requested. |
| Capture Photo | No response field. The user simply submits additional photos.                                        |

<figure><img src="/files/8E1oYIFwHLjzCwYpvJZM" alt=""><figcaption><p>Sample Yes/No Question</p></figcaption></figure>

**Step 3: Adding Custom Photo Capture Flow to API Key**

To setup the Custom Photo Capture, user can select in API-KEY section.

1. Select the "Inclue Custom Photo Capture Flow" in Create or Edit API Key
2. Select the Flow user desire.
3. Save Changes and everything will be ready.&#x20;

<figure><img src="/files/xKSy2m159C1ZRU8iIR5E" alt=""><figcaption></figcaption></figure>

**CaptureUI**

The end user will see the custom capture flow at the end of the inspection process. Below is a sample screenshot:

<figure><img src="/files/NxsL4u5COWYuuZT60sYQ" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/Fgv0PinWDYZW63hS9AH6" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/mOKgSeioVS3nI0eUsRXq" alt="" width="375"><figcaption></figcaption></figure>

**API-Response**

```
"forms": {
        "data": {
            "exterior": {
                "do_you_have_a_roof_rail": true
            },
            "interiors": {
                "is_the_seatbelt_still_intact": true,
                "does_the_vehicle_have_leather_seats": false
            },
            "vehicle_information": {
                "make": "Volkswagen",
                "model": "Golf",
                "model_year": "2015"
            }
        },
        "attachments": {
            "exterior": {
                "do_you_have_a_roof_rail": [
                    {
                        "url": "https:\/\/openapi-cdn.paveapi.com\/sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41ca-0966-4c99-b670-6faf2742e53e.jpg",
                        "path": "sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41ca-0966-4c99-b670-6faf2742e53e.jpg",
                        "size": 1983370,
                        "filename": "user_form-9b0d41ca-0966-4c99-b670-6faf2742e53e.jpg",
                        "extension": "jpg"
                    },
                    {
                        "url": "https:\/\/openapi-cdn.paveapi.com\/sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41e1-8dc7-49d6-9ca2-52f21646e988.jpg",
                        "path": "sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41e1-8dc7-49d6-9ca2-52f21646e988.jpg",
                        "size": 1984286,
                        "filename": "user_form-9b0d41e1-8dc7-49d6-9ca2-52f21646e988.jpg",
                        "extension": "jpg"
                    }
                ]
            },
            "interiors": {
                "is_the_seatbelt_still_intact": [
                    {
                        "url": "https:\/\/openapi-cdn.paveapi.com\/sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41a9-33d6-4551-ac26-2fe9045597de.jpg",
                        "path": "sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41a9-33d6-4551-ac26-2fe9045597de.jpg",
                        "size": 2003328,
                        "filename": "user_form-9b0d41a9-33d6-4551-ac26-2fe9045597de.jpg",
                        "extension": "jpg"
                    }
                ]
            }
        }
```

#### Sample JSON

{% file src="/files/JF8qsY6Doq5GSBqMGjbd" %}


# Overview

The PAVE Branch Dashboard allows clients a summarized view of all the inspections that have been sent to users, along with details and status updates of each of these inspections, in real time.

<figure><img src="/files/wbRtHxDLGsALk7AGcV0U" alt=""><figcaption><p>Dashboard User Interface</p></figcaption></figure>

### Dashboard Features

* **Inspection status summary**:
  * View Total Requests, Inspections not yet started, Opened, Started, and Completed Inspections
* **Summary view by inspection type:**
  * Live view: View all live inspections. ie. in production environment&#x20;
  * Test view: View all test inspections. ie. in test environment
* Send new inspections to users
* View status of each inspection
* Search and Filter inspections
* Track sessions in real time
* **Photos**: View inspection photos and processing time for each photo
* **Notes**: Add session notes for each inspection for future reference
* **Inspection Results**: View inspection results in a shareable HTML page, as well as PDF based Condition Report
* Export Sessions to CSV

{% hint style="info" %}
Note: These features may be visible or hidden from your account dashboard if required by your account administrator&#x20;
{% endhint %}


# User Feature Walkthrough


# Login

How to login to your PAVE dashboard

### Login Credentials

Login credentials are shared at the time of onboarding and will be received via Email.&#x20;

Clients can then use the following URL to login to their PAVE dashboard:

{% embed url="<https://dashboard.paveapi.com>" %}

<figure><img src="/files/CBo6UU8HtSaCllYe8KBC" alt=""><figcaption><p>Login Screen Interface</p></figcaption></figure>


# Live or Test View

Seamlessly switch between Live and Test inspections.

PAVE allows clients to send both live and test inspections to end users. While live inspections are charged to your existing billed usage, test inspections, which simulate the actual experience but are for testing purposes only.

### Live Inspections

<figure><img src="/files/D7gGzQvlniMY9sikswTt" alt=""><figcaption><p>Select 'Live' as highlighted, to view Live inspections </p></figcaption></figure>

Selecting 'Live' , as highlighted above, toggles ON the Live inspection view. Inspections visible in this view are live, i.e. in production environment, and chargeable to your billing cycle.

### Test Inspections

<figure><img src="/files/aRRrCtgMlCeyq1n9XM51" alt=""><figcaption><p>Select 'Test' as highlighted, to view Test inspections </p></figcaption></figure>

Selecting 'Test' , as highlighted above, toggles ON the Test inspection view. Inspections visible in this view are for testing purposes only and are not chargeable to your billing cycle.


# Send Inspections

Send inspections directly from the Dashboard to users as an SMS in two simple steps.

**Step 1**: Click on 'Send Inspection'

<figure><img src="/files/9nLah7rsSCfOcfRv80pw" alt=""><figcaption><p>Step 1: 'Send Inspection'</p></figcaption></figure>

**Step 2**: Add relevant information and click 'Send Inspection'

<figure><img src="/files/u8i2DkE9UTcEe2TyNc7z" alt=""><figcaption></figcaption></figure>

**Enter the following information:**

* Select an API Key (Required)
* Mobile Number of the recipient (Required) <mark style="color:blue;">(</mark>*<mark style="color:blue;">The inspection link SMS is sent to this number)</mark>*
* Mobile Number of the sender
* VIN Number
* Contact Name
* Language <mark style="color:blue;">(</mark>*<mark style="color:blue;">English / Francais)</mark>*

{% hint style="info" %}
In case the Mobile number of the sender is left blank, the account holder's default mobile number is used to receive the SMS with the inspection results URL&#x20;
{% endhint %}

{% hint style="info" %}
Select ***'Send inspection results to this number as well'*** to send the SMS with the inspection results URL to the inspector
{% endhint %}

<figure><img src="/files/3XmrilhDZE7rPn0yMsCw" alt=""><figcaption><p>Inspection Sent Confirmation</p></figcaption></figure>


# Inspection Status

Monitor the status of inspections using visual cues

## Status Codes

Once an inspection is created, it can hold one of the following statuses, and the inspection status can be easily identified by the icon placed on the top left of each listed inspection module.

#### IDLE

In the IDLE Status, the inspection link has been generated and the session is yet to start

<figure><img src="/files/0yEQXfuTCwI2FiTAoZw8" alt=""><figcaption><p>IDLE Status</p></figcaption></figure>

#### STARTED

In the STARTED status, the user has started the inspection by clicking the 'GET STARTED' icon on the Capture UI, but has not yet captured any images

<figure><img src="/files/ml25AJXfzx2uRx5CMxcN" alt=""><figcaption><p>STARTED Status</p></figcaption></figure>

#### PROCESS

In the PROCESS status, the user has started capturing the vehicle photos and the inspection is now in process

<figure><img src="/files/OltIKgmCNuo5REN5sTr4" alt=""><figcaption><p>PROCESS Status</p></figcaption></figure>

#### CAPTURED

In the CAPTURED status, all the session images have been captured and accepted by the PAVE inspection engine. Now the PAVE inspection engine starts detecting the damages.&#x20;

<figure><img src="/files/3Vgm7BZjIjf4aqHYQWks" alt=""><figcaption><p>CAPTURED Status</p></figcaption></figure>

#### WAITING CONFIRM

In the WAITING CONFIRM status, the PAVE inspection engine has completed the inspection process and is awaiting the Condition Report to be generated.

<figure><img src="/files/BpBLzykjearESxpsgFx1" alt=""><figcaption><p>WAITING CONFIRM Status</p></figcaption></figure>

#### COMPLETE

In the COMPLETE status, the Condition Report for the session has been generated as a PDF and the session is now complete.

<figure><img src="/files/td78FkgcuPvX9dCGnIlB" alt=""><figcaption><p>COMPLETE Status</p></figcaption></figure>

#### EXPIRED

Sessions that are not yet complete can be set to 'expire', which then prevents those sessions from processing any further. You can read more about this feature [here](/branch-dashboard/user-feature-walkthrough/inspection-status/expired-sessions).

<figure><img src="/files/tdUwNNGfBvm74saXFZfA" alt=""><figcaption><p>EXPIRED Status</p></figcaption></figure>

**INVALID**

Sessions that cannot be completed due to the presence of an invalid photo such as a photo of a different vehicle.

<figure><img src="/files/NSNJiMBdM0e3NNzjXFR1" alt=""><figcaption><p>INVALID Status</p></figcaption></figure>


# Expired Sessions

Sessions that are not completed can now be expired within a pre-defined time frame. An expired session cannot be processed any further, preventing any potential miss-use or late inspections.

**How 'Expired Sessions' Works**

1. &#x20;Select the desired timeframe beyond which incomplete sessions will be set to expire, as shown below.&#x20;

{% hint style="info" %}
This can be configured at an [API Key](broken://pages/bXlr6VQBbX5aAkWxHJqT) level for a new or existing API Key
{% endhint %}

<figure><img src="/files/rY0Ppe7LeohFBmrKrH6C" alt="" width="563"><figcaption><p>Select a pre-defined timeframe after which sessions will expire</p></figcaption></figure>

2. Once a session expires, it will be visualized on the dashboard as shown below.

<figure><img src="/files/Q76GToHjYlVKnKp568yr" alt=""><figcaption><p>Expired Session icon on the Client Dashboard</p></figcaption></figure>

{% hint style="info" %}
A session will expire if it is **not** in COMPLETE stage (i.e. is still in IDLE, STARTED, or PROCESS stage) when the chosen time frame is reached&#x20;
{% endhint %}

3. For an expired session, the inspection link when opened returns an error message, \
   **'The requested Session Key has already expired'** and no further inspection is possible.

<figure><img src="/files/NrljchF9i8s5RVQrAz5B" alt="" width="375"><figcaption><p>Expired Session</p></figcaption></figure>


# Searching Sessions

Use our search tool and filters to quickly narrow down on a desired set of inspections

PAVE's Branch dashboard allows easy ways to search and sort through existing inspections

<figure><img src="/files/tn36DrW2t9Kx1g3nNJab" alt=""><figcaption><p>The Search and Filter Panel</p></figcaption></figure>

### Filters and Search

Inspections can Filtered with the following options:

#### By Status

Shortlist inspections by selecting a given Status, from the 'Status' dropdown.

<figure><img src="/files/pWk4bQP5KfoIxC27AirK" alt="" width="375"><figcaption><p>Select the status you want to filter by ("Invalid" only available if requested for your account)</p></figcaption></figure>

#### By Month

Shortlist inspections by selecting a given Month, from the 'Month' dropdown.

<figure><img src="/files/BvGOOuxeHAFqX17IkOD2" alt=""><figcaption><p>Select from a given month, or all months</p></figcaption></figure>

#### By Recent Active Sessions, Excluding Idle Sessions, and Undelivered SMS &#x20;

Shortlist inspections by ticking the appropriate checkbox to filter in the results

<figure><img src="/files/bVLbH6sFpTvfk5mYT4Qs" alt=""><figcaption></figcaption></figure>

#### Search by VIN, YMM, Name, Phone, or Session Key

<figure><img src="/files/ibO5aywXAXTYtADUffXY" alt=""><figcaption><p>Search by VIN, YMM, Name, Phone, or Session Key</p></figcaption></figure>

**Filter by API Key**

<figure><img src="/files/VwAngTZAMyTUD4Umctpg" alt=""><figcaption><p>Filter by API key</p></figcaption></figure>


# Photos

Review and analyze photos for each session in high resolution

### How to Review Session Photos

Session photos can be viewed easily within the dashboard itself.

#### Click the 'Photos' icon&#x20;

Click the 'Photos' icon to expand all photos in a thumbnail view along. This view also highlights the status of that image. ie. whether the image is Accepted or Rejected by the AI engine.

<figure><img src="/files/METRtPFlR4MaHUWa8Z6a" alt=""><figcaption><p>Click on 'Photos' to view all Session Photos</p></figcaption></figure>

<figure><img src="/files/l0SHKzZiPkXNweJt4pzp" alt=""><figcaption><p>Photos - Expanded View</p></figcaption></figure>

#### Photo Status and Processing Time

Once a picture is captured and it does not meet specifications it gets rejected by the AI Engine. Once rejected, PAVE Capture will guide the user to capture the image again. This process repeats  till the image gets accepted.

For each photo, the Dashboard view shows the status and the processing time for each image.&#x20;

<figure><img src="/files/1KEmovc9WbIGYWQkXOQr" alt=""><figcaption><p>Photo Status and Processing Time</p></figcaption></figure>

{% hint style="info" %}
VIN image once rejected will prompt the user to enter the VIN manually on the PAVE Capture interface.
{% endhint %}

<figure><img src="/files/tdSOVJnIqx4Ius8yqEl5" alt=""><figcaption><p>Rejected Photo - with reason for rejection</p></figcaption></figure>

<figure><img src="/files/dID3oJ8PWDKhmPMkBJRA" alt=""><figcaption><p>Prompt to enter VIN manually</p></figcaption></figure>

<figure><img src="/files/aLQ0J6lRDDiVPPj0Mb6i" alt=""><figcaption><p>Accepted Image or VIN</p></figcaption></figure>

<figure><img src="/files/L6uTFoWllJ9tS2plz89J" alt=""><figcaption><p>Captured Photos</p></figcaption></figure>


# Session Notes

Simple note taking for each session

### Session Note Taking

#### Overview

The Notes tool allows for seamless note taking for each session. By clicking the Notes button as shown in the image below, a modal opens that allows for notes to be added and saved.

<figure><img src="/files/3pLzAGiZCo6YNpCju6rU" alt=""><figcaption><p>Click on 'Notes' </p></figcaption></figure>

<figure><img src="/files/KQfZ2XKqAEipgYHIBCzt" alt=""><figcaption><p>Add a new Session Note</p></figcaption></figure>

#### Salient Features

* **Add a new note**
* **Give visibility**: make the note visible to,
  * Public&#x20;
  * Yourself only
  * Other Logged-in Users only
* **View previous notes**

<figure><img src="/files/V0eDYJ4P6gcPl1xjc5jk" alt=""><figcaption><p>Submitting a new Session Note</p></figcaption></figure>

<figure><img src="/files/b1TRUWerNT2LgceImAo7" alt=""><figcaption><p>History of previously submitted Sessions Notes</p></figcaption></figure>

Once a new note has been submitted, the Notes icon gets updated to reflect the count of notes for this session.

<figure><img src="/files/rq6vxYrC9A6lCGegvPl5" alt=""><figcaption><p>Updated 'Notes' highlighting the count of Session Notes. ie. One Session Note for this session</p></figcaption></figure>


# Inspection Results

View inspection results through a dedicated HTML Park Page

### Inspection Results

Once an inspection is complete, the results are available in both an HTML format and a PDF based Condition Report.

To view the inspection results, simply click the 'Results' icon, which then opens the inspection results in a new browser window or tab in an HTML format.&#x20;

<figure><img src="/files/LfaGmqTd2QmVznN1u2hl" alt=""><figcaption><p>Click 'Results' to view the Inspection Results</p></figcaption></figure>

#### Results Page

The results HTML page details the inspection results.&#x20;

It consists if many sections, such as

* Session Details
  * Date
  * Address (if applicable)
  * Session ID
* Vehicle Information
  * VIN
  * Year Make Model
  * Trim
  * Engine
  * Transmission&#x20;
  * Odometer
  * Colour
* Vehicle Grading
* Link to Condition Report PDF
* Vehicle Photos
* Damage Details

<figure><img src="/files/2kYx2t6FHSm0tm9VJGnA" alt=""><figcaption><p>Inspection Report</p></figcaption></figure>

{% embed url="<https://dashboard.paveapi.com/park/UDB-512D3TASIY>" %}

{% hint style="info" %}
The Results page URL is shareable and does not expire&#x20;
{% endhint %}


# Condition Report PDF

### Condition Report

The Condition Report is a document that highlights the inspection results in a PDF format. This report can be modified to meet the client's branding and custom requirements.

The Condition Report can be opened by clicking the 'Condition Report PDF' icon on the Inspection Result HTML page.

<figure><img src="/files/4pSoO8v37MmyzeM2eeOA" alt=""><figcaption><p>Click the 'Condition Report PDF' on the Inspection Report to open the Condition Report</p></figcaption></figure>

<figure><img src="/files/yVfclzV5ws7QS4fZBg4N" alt=""><figcaption><p>Condition Report</p></figcaption></figure>

<figure><img src="/files/njkyO3T9I9UZrcTbEsiB" alt=""><figcaption><p>Interior Cleanliness Scoring is a beta feature.  Ask your PAVE rep for more information</p></figcaption></figure>


# Export Sessions

Export session data in CSV format

### Sessions Data

Sessions data is available to download in a CSV format.

{% hint style="info" %}
Multiple session files can be generated at once
{% endhint %}

{% hint style="info" %}
Each file generated has a validity of 6 days. \
If expired, a new file can be generated using the steps shown below.
{% endhint %}

#### How to generate a session file

<figure><img src="/files/IqpMM1cCNX5u2VbZgzMF" alt=""><figcaption><p>Step 1: Click on 'Download Sessions'</p></figcaption></figure>

To generate a session file, click on 'Download Sessions' in the Dashboard panel.

<figure><img src="/files/240Hn5V6SgulJig5Zlnc" alt=""><figcaption><p>Select the session status you wish to include in the export ("Invalid" only available in an account if requested)</p></figcaption></figure>

The Download Sessions modal then allows for filtering between API Keys, Time ranges, and inspection statuses. Once the criteria has been selected, clicking 'Submit' generated the session file.

<figure><img src="/files/5lk8x1UcuuKRSwjzK1K5" alt=""><figcaption><p>Step 3: Within 'Session Files' click the File Name to download the CSV file</p></figcaption></figure>

Each session file generated is housed inside the 'Session Files' panel. Each file has a validity of 6 days for security reasons. Clicking the file name initiates the CSV file download.&#x20;


# VIN Assignments

This feature allows the assignment of specific VINs to PAVE's branch accounts from the Enterprise Administrator, so that the Branch Dashboard user knows which specific VINs to inspect for their fleet

## How to navigate the 'VIN Assignments' feature

### Step 1: Accessing the feature

After logging into your Branch dashboard, access this feature by navigating to 'Dashboard' and then 'VIN Assignments' tab

Here, you can see the list of VINs that are assigned to your account, as shown below.

<figure><img src="/files/teauX1v5Ua9gtEpyEilm" alt=""><figcaption><p>VIN Assignment View</p></figcaption></figure>

{% hint style="info" %}
The VINs are pre-assigned by your Enterprise Administrator and when new VINs are assigned to your account, the VIN list will get automatically updated on your dashboard.
{% endhint %}

{% hint style="success" %}
Please ensure the 'SETTINGS.VIN-ASSIGNMENTS' permission is turned ON for this account.\
[Read here for more information](/branch-dashboard/user-feature-walkthrough/settings/users/different-user-types-and-permissions)
{% endhint %}

### Step 2: Create an Inspection for the Assigned VIN

Launch an inspection from the Dashboard by clicking on “[Send Inspection](/branch-dashboard/user-feature-walkthrough/send-inspections).” Enter the API and phone number you’d like to send the inspection to along with the VIN of the vehicle to be inspected.<br>

<figure><img src="/files/3tSlI89dNHeY3EMDti3m" alt=""><figcaption><p>Send Inspection from the dashboard with the VIN included</p></figcaption></figure>

### Step 3: Capture the Vehicle with the Specified VIN&#x20;

Launch the PAVE inspection app and capture the required photos for the specified VIN.

### Step 4: Verify Completed Inspections for Assigned VINs&#x20;

Once the inspection has moved to COMPLETED status, The session ID will appear in the Inspection column and will be linked to the inspection report.

<figure><img src="/files/vvBk4RzRGA1z4Rc0NY1H" alt=""><figcaption><p>Completed VIN Assigments as seen on the Branch Account</p></figcaption></figure>

{% hint style="info" %}
When you click on the Inspection ID, as shown above, it will open the Condition Report PDF in a new URL tab
{% endhint %}


# Developer Tools


# API Keys

Create and Manage your API Keys

### API Keys

#### Overview

An API Key is a code used to identify, authenticate, and authorize a user. \
\
PAVE Capture API calls require authentication in the form of an [**HMAC-SHA256**](https://en.wikipedia.org/wiki/Hash-based_message_authentication_code) message hash as a header within the request.

{% embed url="<https://docs.paveapi.com/integrations/developer-docs/authentication>" %}

#### Creating a new API Key

<figure><img src="/files/scLKcVwDy12YBOJ982eA" alt=""><figcaption><p>Step 1: Click 'Create New Key' to get started</p></figcaption></figure>

Creating a new API Key is a simple process. Click on the the 'Create New Key' button to get started.

<figure><img src="/files/pmoqbmZiDpvPhsECu5ED" alt=""><figcaption><p>Step 2: Add required information and customizations and click 'Create'</p></figcaption></figure>

Then, provide the information on the Create New Key modal and then click 'Create'.

#### Reference Guide

The following is a reference guide for the information requested on the Create New Key modal

#### Reference Guide

The following is a reference guide for the information requested on the Create New Key modal

| Criteria                    | Definition                                                                                                                                         |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Key Name**                | Give your API Key a unique name                                                                                                                    |
| **License**                 | <p></p><p>Chose between one or more licenses assigned to your account</p>                                                                          |
| **Live**                    | <p>Toggle ON to generate a Live API Key<br>Toggle OFF to generate a Test API Key</p>                                                               |
| **Default Theme**           | Choose between Lite and Pro Capture UI Themes                                                                                                      |
| **PII Mask**                | Toggle ON to remove or blur Personal Identifiable Information such as VIN, Address, License plates on photos, on the results HTML page and the CR. |
| **Redirect URL**            | This is a custom URL to which the user will be redirected once a PAVE Capture is completed                                                         |
| **Capture Options**         | Customize the Pave Capture experience by skipping Interior and/or Odometer captures, and by including Disclosures and/or Announcements             |
| **Customize Capture SMS**   | Customize the SMS message that is sent to the user along with the capture link URL                                                                 |
| **Customize Results SMS**   | Customize the SMS message that is sent to the user along with the capture results URL                                                              |
| **Wear and Tear Estimates** | Add wear and tear estimates to the Results Page and the Condition Report PDF                                                                       |
| **Expired Sessions**        | Set a time frame after which an incomplete session generated by this key will expire and not functional anymore                                    |

{% hint style="info" %}
**Skip Odometer** When 'Skip Odometer' is selected, the Odometer image is skipped and a Manual Odometer reading is required instead, during a PAVE session.&#x20;
{% endhint %}

#### List of API Keys

<figure><img src="/files/nkvAVq1ltyrffTbADD7L" alt=""><figcaption><p>All existing API Keys are visible in the Dashboard, API Key view</p></figcaption></figure>

All existing and new API Keys are visible in the API Key view on the Dashboard. This view includes the Key Name, API Key, and the API Secret Key.


# API Logs

View API Requests and Responses

## API Logs

A PAVE customer may want to analyze API requests sent in the Live or Test environment from time to time.

Using API logs, you can see the information about your API requests and responses , depending on the request method. ie POST, GET, PUT, DELETE, for a session.&#x20;

The logs show all API requests made along with their response received.&#x20;

<figure><img src="/files/FMZiXRmBzHetXpAoEICq" alt=""><figcaption><p>API Logs</p></figcaption></figure>

<figure><img src="/files/YZeypB1a1bhKzQDtlvsu" alt=""><figcaption><p>Types of API Logs</p></figcaption></figure>


# Sessions Events

View all Session Events and Payload data

### Session Events

<figure><img src="/files/kNKzbOgJZ8PazCC4yzLh" alt=""><figcaption><p>Session Events</p></figcaption></figure>

Each event that is triggered during an inspection is logged in the Session Events panel. This list details the event and its status, as well as provide the Session Key and the Timestamp of that event.

<figure><img src="/files/smvvUVwWcSyNc3C5CS5G" alt=""><figcaption><p>Event details and status</p></figcaption></figure>

{% hint style="info" %}
Events when opened show the complete Payload Load details for that event
{% endhint %}

<figure><img src="/files/ZHSs9mwPWUpdt81tcith" alt=""><figcaption><p>Event Data</p></figcaption></figure>

<figure><img src="/files/0TUcFhfhV7pmSVmdyy3s" alt=""><figcaption><p>Event Types</p></figcaption></figure>


# Webhooks

Create webhooks and get notified for supported events for all sessions relating to your API-Key through a JSON payload.

### Setting Up a Webhook

**Step 1:** Add a new Webhook on your PAVE dashboard as shown below

<figure><img src="/files/LsL4gdifz3M9TRpkClid" alt=""><figcaption><p>Add a Webhook</p></figcaption></figure>

**Step 2:** Configure the settings as per your use-case and click 'Create'

<figure><img src="/files/YvZRhemw87VUfLGcVlpr" alt=""><figcaption><p>Configure a Webhook</p></figcaption></figure>

| Parameter       | Description                                                                                                                     |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| API Keys        | Select the API Key associated with this webhook                                                                                 |
| Callback Events | Select the Callback Event you would like to set up. Read more about Callback Events [here](broken://pages/-Mar22soarTMZDpJSvp5) |
| Endpoint        | Add the Endpoint URL where you would like to receive the JSON associated with the Callback Event                                |
| Method          | Based on your selected Callback, the API operations such as GET, POST, PUT get selected automatically. No action for the user   |

{% hint style="info" %}
You can only set up one webhook event per API Key per Callback Event.&#x20;
{% endhint %}

#### Manually Sending a Webhook

Webhooks once set, can be sent manually using the PAVE dashboard as well. This is required in cases where the webhook did not send or saw an error.&#x20;

Please see the screenshot below on how to send a webhook manually:

<figure><img src="/files/hpwOJqqRHYc2HBSk1Yad" alt=""><figcaption><p>Manually Send a Webhook</p></figcaption></figure>


# Settings


# Account


# Changing your password

### Account Management

Accounts can be managed in the Settings panel under the Account section.&#x20;

<figure><img src="/files/YsQ9vO9kgirFM6PKIfQ3" alt=""><figcaption><p>Account Details</p></figcaption></figure>

#### Changing Password

<figure><img src="/files/Qa3fI9d5FrDGUCT7Wi57" alt=""><figcaption><p>Changing Password</p></figcaption></figure>

The password can be changed easily inside the 'Change Your Password' modal by entering the details as required, and then clicking 'Change Password'


# Google Single sign-on

### Google SSO (Single Sign On)

Clients can use their Google credentials to authenticate and log into PAVE Dashboard

<figure><img src="/files/NVDuBTKHb4rmsT5Ib6L3" alt=""><figcaption><p>Step 1: Click on Login With Google</p></figcaption></figure>

<figure><img src="/files/aCcdagguiBku3tKmpZWA" alt=""><figcaption><p>Step 2: Add google email and click 'Search &#x26; Join Workspace'</p></figcaption></figure>


# Branding


# Overview

Set your brand to be used for PAVE's capture interface

PAVE allows for customization and white labelling of the User Interface and Conditional Reports, to meet our client's custom requirements.

In this section, we will learn the different types of interface and communication customizations that PAVE offers.


# Logos

Upload your brand logo to replace the PAVE logo on the capture interface

### Logos

Pave allows for custom logos to be displayed on **both the light and dark-colored** components of the capture interface.

To do so, simply upload the Dark and Light logo for your brand, separately on the Branding panel.

<figure><img src="/files/3ZuaAWRN3acaYxmGQ0bP" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Logo image must not exceed 512px in height
{% endhint %}


# Background Colour

To further customize, any background and text color can be added to further enhance the custom brand experience.&#x20;

<figure><img src="/files/vviJfexIGJ1f5iYbXPPN" alt=""><figcaption><p>Color related customization</p></figcaption></figure>


# SMS Message / Results Customization

### Custom Communication

During the PAVE process, two SMS messages are generated. The first contains the inspection link, and the second contains the URL to the Inspection Results.

Both these messages are customizable as shown below. These can be customized to client's brand and messaging verbiage as required.

<figure><img src="/files/uZACwcY0qHwUXpJqOVKF" alt=""><figcaption></figcaption></figure>


# Customize Video

Add a custom YouTube video to the PAVE capture home screen

### Customize Home Screen Video

You can now customize the video on the PAVE Capture home screen as per your branding requirements.

<figure><img src="/files/9xQFxXQHx4l1ZBdBKRzl" alt=""><figcaption><p>Default Video on the Capture Home Screen highlighting the PAVE Capture process.</p></figcaption></figure>

####

#### Steps to Change the Capture Home Screen Video

1\. Toggle ON the 'Customize Videos' button, inside 'Branding', under 'Settings'

<figure><img src="/files/gHHs3GONi63BYEJIjwQj" alt=""><figcaption></figcaption></figure>

2\. Add the YouTube video link&#x20;

<figure><img src="/files/9hwjRotarwyi1V525i5N" alt=""><figcaption></figcaption></figure>

3\. Done. Any new sessions created will reflect the custom YouTube link added above.

<figure><img src="/files/xxkvliRMAkx4mGZZXuTp" alt=""><figcaption><p>Custom Video added to the Capture Home Screen</p></figcaption></figure>

{% hint style="info" %}
This feature only supports YouTube videos at this time.&#x20;
{% endhint %}

#### Adding Custom Video to a specific API Key

You can also add a custom video for Capture sessions generated by a specific **API Key**

1. [EDIT](broken://pages/bXlr6VQBbX5aAkWxHJqT) the API Key for which to add custom video links.
2. Add the Custom Video Link as shown below.
3. Click 'Save Changes'

<figure><img src="/files/Hfm9Jfn445HhNDKhCp7u" alt=""><figcaption><p>Add a Custom Video Link on the Home Screen for sessions generated by specific API Keys</p></figcaption></figure>

{% hint style="info" %}
'Customize Video' feature must be [Toggled ON](#steps-to-change-the-capture-home-screen-video) prior to setting up API Key specific custom home screen video links
{% endhint %}

{% hint style="info" %}
API Key specific home screen videos can be different than the video added for all other sessions [here](#steps-to-change-the-capture-home-screen-video)
{% endhint %}


# Users


# Finding and Editing Users

Browse and make changes to the user list

### User List

The list of users can be found in the Settings panel, inside the 'User' section.&#x20;

In case the user list is quite large, there is a search bar located above the list from where a user can be found using keywords.&#x20;

<figure><img src="/files/vLfJvgSnsHqtvasQD50C" alt=""><figcaption><p>List of Users</p></figcaption></figure>

User details can be edited easily by selecting a user and clicking on the 'Edit' button next to the user's username.&#x20;

<figure><img src="/files/486ZbLCLDM0WVLRrYSZF" alt=""><figcaption><p>Click 'Edit' to make changes to the user's details</p></figcaption></figure>

Once changes are made to the existing user, click 'Save Changes' to save these changes and close the modal.

<figure><img src="/files/zB2JY5VxRkcRHT5Zar5Z" alt=""><figcaption><p>Click 'Save Changes' once any changes have been made</p></figcaption></figure>


# Creating A New User

#### Creating a User

To create a new user, select 'Users' inside the Settings panel and click on the 'Create New User' button.&#x20;

<figure><img src="/files/lhYGLyVWos4VdKhfDikw" alt=""><figcaption><p>Step 1: Click 'Create New User</p></figcaption></figure>

Then, choose between either an **Admin** or a **User** role, depending on the level of permissions to be granted to that user.&#x20;

#### USER ROLE: ADMIN

Admin Users have a vast suite of access permissions available to them which can be toggled ON as per the requirement. These different permission types are explain in detail [here](/branch-dashboard/user-feature-walkthrough/settings/users/different-user-types-and-permissions).

<figure><img src="/files/g9BK6AV9NLaBQhqjsq1p" alt="" width="563"><figcaption><p>Step 2: Select the User Role, Enter the Required details, and select the User Permissions</p></figcaption></figure>

Finally, generate a temporary password and click 'Create', and this creates a new user.

<figure><img src="/files/3yZJypzJHQ1rmotD36di" alt="" width="563"><figcaption><p>Final Step is to generate a password and finish creating the user</p></figcaption></figure>

#### USER ROLE: USER

The User, as compared to an Admin, can only access sessions of a select, or all, API keys. Their dashboard view is limited to viewing and sending inspections related to the permitted API key only.

<figure><img src="/files/xW5ErGZ9qjAkgzJReNqH" alt="" width="563"><figcaption><p>User Role: USER</p></figcaption></figure>

{% hint style="info" %}
Toggling ON 'Send Password to the Associate Email Address' is required for emailing the temporary email credentials to the new user via an email. \
\
Note: You can always create a user first and then go back to this setting and turn the toggle ON, in case you would like to trigger a welcome email at a later date.&#x20;
{% endhint %}


# Different User Types and Permissions

### User Types

There are two user roles to choose from, **Admin** and **User.** Each role has specific permissions and features granted.

#### Admin Role

An Admin can access the full feature set on the platform. Namely, the Dashboard and Session Files. Additionally, an Admin can also access the Developer tools, such as, API Keys, Logs, Session Events, Webhooks, as well as the Settings, which include, Account and User management, Branding, Widgets,  Batches, Estimates, and Integrations.&#x20;

<figure><img src="/files/fn5OGkgLO1DN5XWjHvZm" alt="" width="563"><figcaption></figcaption></figure>

| Access Permission                                                                                      | Definition                                                                                                                        |
| ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
| [SESSIONS.DASHBOARD](/branch-dashboard/user-feature-walkthrough/live-or-test-view)                     | This setting allows the user to access the dashboard view to monitor and send new inspections.                                    |
| [SESSIONS.FILES](/branch-dashboard/user-feature-walkthrough/export-sessions)                           | This setting allows the user to generate and download session files as CSV                                                        |
| [SESSIONS.VIN-ASSIGNMENTS](/branch-dashboard/user-feature-walkthrough/vin-assignments)                 | This setting is coming in 2024 and will allow users to initiate inspections based on a list of VINs pre-assigned to their account |
|                                                                                                        |                                                                                                                                   |
| [DEVELOPER.API-KEYS](/branch-dashboard/user-feature-walkthrough/developer-tools/api-keys)              | This setting allows the user to create new or manage existing API Keys                                                            |
| [DEVELOPER.API-LOGS](/branch-dashboard/user-feature-walkthrough/developer-tools/api-logs)              | This setting allows the user to access API logs related to their sessions                                                         |
| [DEVELOPER.SESSION-EVENTS](/branch-dashboard/user-feature-walkthrough/developer-tools/sessions-events) | This setting allows the user to see individual session events for each Session Key on their account                               |
| [DEVELOPER.WEBHOOKS](/branch-dashboard/user-feature-walkthrough/developer-tools/webhooks)              | This setting allows the user to create or manage Webhooks for sending session events to their endpoint URLs                       |
|                                                                                                        |                                                                                                                                   |
| [SETTINGS.ACCOUNT](/branch-dashboard/user-feature-walkthrough/settings/account)                        | This setting allows the user to manage their account and login password                                                           |
| [SETTINGS.BRANDING](/branch-dashboard/user-feature-walkthrough/settings/branding)                      | This setting allows the user to set up white-label options on their PAVE account                                                  |
| [SETTINGS.USERS](/branch-dashboard/user-feature-walkthrough/settings/users)                            | This setting allows the user to create and manage users on the PAVE dashboard                                                     |
| [SETTINGS.WIDGETS](/branch-dashboard/user-feature-walkthrough/settings/widgets)                        | This setting allows the user to create and manage widgets and sharable links                                                      |
| [SETTINGS.BATCHES](/branch-dashboard/user-feature-walkthrough/settings/batches)                        | This setting allows the user to create data export batches to enable data sharing via SFTP                                        |
| [SETTINGS.ESTIMATES](/branch-dashboard/user-feature-walkthrough/settings/estimates)                    | This setting allows the user to the user to access the Repair Estimates feature on their dashboard                                |
| [SETTINGS.INTEGRATIONS](/branch-dashboard/user-feature-walkthrough/settings/integrations)              | This setting allows the user to access the Integrations feature on their dashbaord                                                |
| [SETTINGS.CUSTOM-CAPTURE](/branch-dashboard/user-feature-walkthrough/settings/custom-capture)          | This setting allows the user to access the Custom Capture feature and setup a custom capture flow on their photo capture sequence |
|                                                                                                        |                                                                                                                                   |
| DISPUTES.DASHBOARD                                                                                     | This setting allows the user to view their dispute status on the dashboard for all disputed sessions                              |

#### User Role

A User has limited permissions as compared to an Admin. A user can send inspections and manage sessions through the dashboard, for the selected or all API Keys.

<figure><img src="/files/CjCSPBVcA00iOgRGc7Ke" alt=""><figcaption><p>User Access View</p></figcaption></figure>

When a User role has been set up, this user can only access the Dashboard view for the specific API key to which they are granted access.&#x20;

As part of a 'User' role, users are only able to see the following features on their PAVE dashboard:

1. [Dashboard View](/branch-dashboard/user-feature-walkthrough/live-or-test-view)&#x20;
2. [Send Inspections via Dashboard](/branch-dashboard/user-feature-walkthrough/send-inspections)
3. [Session Files](/branch-dashboard/user-feature-walkthrough/export-sessions)
4. [Account Management](/branch-dashboard/user-feature-walkthrough/settings/account)&#x20;
5. [Widgets](/branch-dashboard/user-feature-walkthrough/settings/widgets)


# Deactivating and Reactivating Users and Admins

Deactivating an Admin or User

To deactivate a user account, please follow these steps:

1. Navigate to the **Settings** menu from your main dashboard.
2. Within the **Settings** menu, select the **Users** option to view a list of all user accounts.
3. Locate the account you wish to deactivate by scrolling through the list or using the search function.
4. Click on the **Edit** button located next to the user's account information.
5. Find and select the **Deactivate This Account** option in the user's account settings.
6. Confirm the deactivation to complete the process.

Please make sure you have the necessary administrative permissions to perform these actions. Once a user account is deactivated, the user will no longer have access to the system until their account is reactivated.

<figure><img src="/files/SCmzprnv7mDUFmVCjKIc" alt=""><figcaption></figcaption></figure>

To reactivate a user account, please follow these detailed steps:

1. Access the **Settings** section from your main dashboard.
2. Click on the **Users** tab within the **Settings** to display the list of user accounts.
3. Find the account you want to reactivate. You may need to filter or search if there are many accounts.
4. Click the **Edit** button adjacent to the desired account to enter its settings.
5. Look for the **Reactivate Account** option in the account settings and select it.
6. Confirm the reactivation to grant the user access to the system again.

Reactivating an account will restore the user's access to all their previous system permissions and data.


# Receive Condition Reports via Email

You can receive email delivery for all completed condition reports for any Admin or User in your account alongside the available SMS notifications.<br>

**Steps to Enable:**

1. Go to 'Settings' and then 'Users.'
2. Choose an existing user or create a new one to receive the condition reports.
3. Toggle the option "EMAIL USER ALL COMPLETED CONDITION REPORTS" to 'On' and save the changes.

<figure><img src="/files/JATJBf3R8fO0GvKWMGOm" alt=""><figcaption><p>Toggle ON the 'Email User All Completed Condition Reports' feature</p></figcaption></figure>

Once enabled, any newly completed condition reports will be automatically sent to the selected user's email address. To stop receiving reports by email, please return to the user's settings, switch the toggle to 'Off,' and save your changes.


# Widgets


# Overview

Widgets are a convenient way to launch inspections directly from your website through an embedded widget

## Widgets

With PAVE's unlimited Website Widgets and Shareable Links, you can provide multiple options for your customers to self-request inspection links either from your website or from a shareable URL. You can also install a shareable link to launch inspections directly from your smart-phone without logging into the PAVE dashboard.&#x20;

### Website Widget

You can set up a website widget on any page on your website. The widget is specially coded to that page, so when someone requests a new inspection, the new inspection will appear on your dashboard under the name of your widget. The screen shot below is an example of a website widget on a dealership website.

<figure><img src="/files/bF2o6vacAJFDL76uaoI6" alt=""><figcaption><p>The widget allows website visitor to self-request an inspection link.</p></figcaption></figure>

### Shareable Link

With a shareable link, you can provide a URL in an email or a QR code on a letter that customers can link to in order to self-launch a vehicle inspection. The example below is a lease-end pre-inspection mailer that can be sent to customers prior to an expected lease termination to assess any additional damages.

<figure><img src="/files/FvP69BvQzkPyrUZy2NH3" alt=""><figcaption><p>Sample Email with the embedded QR Code to initiate a PAVE inspection</p></figcaption></figure>

### Smartphone "Quick Launch" Shareable Link

<figure><img src="/files/MMi9yTYOTM21tRIDjcWk" alt=""><figcaption><p>Launch Inspections from anywhere with a customized "Quick Launch" shareable link on your smartphone.</p></figcaption></figure>

Our users tell us that one of the most convenient things about PAVE is the ability to launch an inspection from a link on your smartphone anywhere and anytime. Some examples of when you might need this feature:

***1) Run into a customer at the grocery store who's interested in trading?*** Send them a link directly from your phone, and once completed, you will see it appear on your dashboard under your PAVE username.&#x20;

**2)&#x20;*****Having a busy Saturday afternoon and there's a line-up for appraisals from the used car manager?*** Send yourself a link, capture your customer's vehicle using your own phone, and have your manager appraise it later when they have some time.&#x20;


# Creating a Website Widget

#### New Widget

Creating a new widget is simple. By clicking the 'Create New Widget' a user can create a custom widget quickly.

<figure><img src="/files/PJPc6huoAFP6KAmkL25d" alt=""><figcaption><p>Create New Widget</p></figcaption></figure>

Select 'Embed Widget' widget type and add the details as shown below. Customization can be done in terms of styling, colors, text, and headline.&#x20;

Google Analytics can also be integrated into the widget by adding the GA Tracking ID as requested.

<figure><img src="/files/EaKk2tfuyvzwpNwkoBtb" alt=""><figcaption><p>Create Widget</p></figcaption></figure>


# Editing an existing Website Widget

#### Editing an existing widget

Existing widgets can be edited by selecting 'Edit' for the required Widget, as highlighted below.

<figure><img src="/files/FewJd7vrpRRxQgyxRF2d" alt=""><figcaption><p>Click on Edit to modify an existing Widget</p></figcaption></figure>

<figure><img src="/files/N8qGrusAWNaK5ySiNLfh" alt=""><figcaption><p>Any required changes can be made, and then click on 'Save Changes' to save.</p></figcaption></figure>


# Preview a Website Widget

Existing Widgets can be previewed in HTML. This helps get a feel for the actual user experience with the widget on the client's actual website.

To preview a widget, simply click on 'Preview.

<figure><img src="/files/MSUvPZSBVdNnQ3PM0VSw" alt=""><figcaption></figcaption></figure>

Once 'Preview' is clicked, the user is redirected to a new webpage that shows the actual widget interface on the webpage.

<figure><img src="/files/PLuXXtYcMblMfUCVDmOD" alt=""><figcaption><p>Widget interface</p></figcaption></figure>


# Installing a Website Widget on Your Website

Forever Change How You Inspect and Appraise Used Vehicles

<figure><img src="/files/iL7e4YJkZ1arzIqnXhie" alt=""><figcaption></figcaption></figure>

## Overview

With PAVE's easy to use JavaScript, you can replace your long "online appraisal" or "sell your car" forms on your website by only requiring visitors to enter their name and phone number to get a PAVE link sent to them directly. PAVE will automatically gather the rest of the needed information from the photos as they capture them.

## Website Installation

When they submit their phone number to get sent a PAVE link, their session and progress will automatically show on your dashboard as being sent from your webpage under the name you gave your widget for easy tracking. Once they are complete in doing their capture, the people you have set up to get notified will receive a link by text with the results.

For embedding on your website, you have two options;

1 - **iframe**: This option allows you to embed the PAVE Inspect form as a frame or an external resource.

2 - **floating form**: This option allows you to add the PAVE Inspect form to hover on the bottom center of any page where the script gets added.

**Iframe: (optional)**

Your website layout and the theme used will affect how your form appears on your web page. We calculate the height and the width of your form based on the container size where you embed the form.

To embed the PAVE Inspect form, first create the container on your webpage where you want it to be placed. Once created, replace the 'YOUR\_CONTAINER\_ID' in the script that is displayed for that widget with the name you gave this container.

```
**SAMPLE ONLY**

<script src="https://uat.paveinspect.com/js/launch-widget.js"></script>
<script>
  initPAVELauncher({
    'container': 'YOUR_CONTAINER_ID'
    'src': 'https://uat.paveinspect.com/launch-widget/43b4a899-6bf1-48b8-ae72-451d08aac5e9'
  });
</script>

**SAMPLE ONLY** the script for your website is created in SETTINGS when you activate a new form.

```

Copy the script for your form and add it within the \<body> of your page. The form will automatically load inside the defined container.

**Floating form: (default)**

If you choose not to enter a designated container for where the PAVE Inspect form appears within your web page, the form will automatically default to float on the bottom center of the page.&#x20;

### Where to find 'YOUR\_CONTAINER\_ID'

The 'Container ID' is the ID that was given for the \<div> where you want the form to be displayed on your webpage. \<div id="form" class="container">

You can find this in the HTML for your page. If you only have a \<div class="container'> you should add an ID to your container and enter it in the script before adding it to your \<body> . Using the name of the "class" instead of the "id" may not work correctly as you may have several containers with the same class.&#x20;

Directly copy the script for each of the forms that are displayed in your SETTINGS for the widget and insert it inside the of each page you wish to display the form.


# Sharable Links

A sharable link is a pre-configured URL for sending PAVE sessions to users from a shareable, re-useable link, or a QR Code

## Sharable Link Feature

The Sharable Link feature can be easily located on the dashboard, inside SETTINGS > WIDGETS, as shown below

<figure><img src="/files/dC56XqAbAPPkcgrXKpSo" alt=""><figcaption><p>Sharable Link Feature</p></figcaption></figure>

### Creating a Sharable Link

Create a new Sharable Link in a few simple steps

**Step 1**: Select 'Create New Widget' on the Widget's page

<figure><img src="/files/tMUgyZjM0newpIUnc4Eh" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Best Practice: The name of your shareable link should reference the intended purpose of the link. For Example "Remarketing', or 'Lease Return - Dallas'
{% endhint %}

**Step 2**: Select 'Sharable Link' on the 'Create New Widget' pop-up.

<figure><img src="/files/qo8vLlmOSbGxju1c25kP" alt=""><figcaption></figcaption></figure>

**Step 3**: Add the details such as, 'Widget Name' and the 'API Key' you would like this Sharable Link to be linked with. If needed, you may select the optional settings as well, as explained ahead.

<figure><img src="/files/io5aS3C2rxgLP51sMDfv" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Select 'Use Sharable URL as the Redirect URL' if you would like the PAVE inspector to return to the Sharable Link Launcher Page to initiate another PAVE inspection after completing the first one.
{% endhint %}

**Step 4**: Your new Sharable Link and QR Code is ready&#x20;

<figure><img src="/files/IllgxQ0dQO0NcG1Ol3aM" alt=""><figcaption><p>Sharable Link Details</p></figcaption></figure>

<figure><img src="/files/HwBTwgN2FPPpp3poDGu2" alt=""><figcaption><p>Sharable Link URL</p></figcaption></figure>

<figure><img src="/files/7El194YlLkkz7hEotPeg" alt="" width="300"><figcaption><p>Downloadable QR Code</p></figcaption></figure>

### Using the Sharable Link

There are two ways to use a Sharable Link

#### 1. Sharable Link URL

You can share the Sharable Link URL. Using the launcher form, you can send an inspection to any mobile number through an SMS, to initiate a PAVE.

<figure><img src="/files/LGIdFjZSy6qQ4RpAJBQc" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/FUVmsJSiMkgzUQ4sgOMo" alt=""><figcaption><p>Sharable Link Launcher Page</p></figcaption></figure>

#### 2. QR Code

You can also download and distribute the QR Code, which when scanned through a mobile device directs the user to the Launcher Page

<figure><img src="/files/bpGfQ4lfktUX7OU0hc3L" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/UiHLxYeRvhhUJ0gwIfFk" alt="" width="300"><figcaption><p>QR Code</p></figcaption></figure>

{% hint style="info" %}
Note: Your custom branding logo will show on the QR code, if you have uploaded a logo on the PAVE dashboard, prior to a Sharable Link being created. \
\
Once created, the QR code, which is hard coded, does not update/change the logo imprinted on it.
{% endhint %}

###

### Previewing the Sharable link launch page

To preview a sharable link you can click on the Preview option, as shown below. This link, which is the same as the Sharable Link URL, opens in a new webpage to preview.&#x20;

<figure><img src="/files/51XwsrnlGN4XPI0fo5LY" alt=""><figcaption><p>Preview the Sharable Link</p></figcaption></figure>


# PAVE App icon

How to create an App icon to launch the Sharable Link page

### Creating a PAVE App icon&#x20;

**Step 1:** Highlight and copy your shareable link from the dashboard

<figure><img src="/files/HD8PCMup0SoamDRy46gE" alt=""><figcaption><p>Copy the Sharable Link URL</p></figcaption></figure>

**Step 2:** Open the link with your phone's native browser (Safari for iPhone and Chrome for Android), click the share link button (iPhone: bottom centre; Android: Top Right) and select *“Add To Home Screen*”. A PAVE icon will now appear on the home screen.

<figure><img src="/files/fYWyQZFFW0nkWpuuOZri" alt=""><figcaption><p>PAVE App Icon on the Home Screen</p></figcaption></figure>


# Batches

Set up batches to generate CSV files of session data with the preferred filters

<figure><img src="/files/oCPgYB7sqbCaBEAdjP0m" alt=""><figcaption><p>Batches</p></figcaption></figure>

#### Creating a new Batch

* Give your batch a name and select which API key you wish to have the related session data transferred.&#x20;
* Enter whichever session STATUS you wish to include (most often only COMPLETE, which are sessions with full results.)
* Select the FREQUENCY to have this file generate and transfer any new sessions since generated and not included in the previous batch.&#x20;
* You can also set this batch to Auto to generate a new batch for any new sessions since the last file was generated or manually select whichever session you wish to include. This will add a button directly to any sessions with the desired status you set (like COMPLETE.)
* Enter the SFTP credentials for the endpoint to which you wish to transfer your session files.

{% hint style="info" %}
You can also set any specific license code to be used by any of these API keys.&#x20;

Using unique license codes will allow us to modify the CSV file to any requirements that would only impact sessions for API keys that use this license.
{% endhint %}

{% hint style="info" %}
Add up to 20 batch settings per account to share results with any third parties or send this same data to any own FTP/SFTP server(s).
{% endhint %}


# Estimates

Provide damage repair and replacement estimates on the Condition Report PDF

#### Estimates

Excess Wear and Tear detected by PAVE can be classified as replaceable or repairable. For each damage, if the Admin so chooses, the damage repair cost estimates can be made and displayed within the Condition Report PDF.

The repair/replacement costs can be manually entered and saved on the dashboard. Once the report is run, it will directly take the estimates and publish them on the Condition Report PDF.

<figure><img src="/files/qcSvkONTpsQSaVaASBnQ" alt=""><figcaption><p>Wear and tear estimates</p></figcaption></figure>

**Editing Estimate Values**

The **"ESTIMATES"** section can be found under "**SETTINGS"** tab of the client dashboard. At this time, the UI will display all 375 available components within the 4 sub-groups of BODY, PARTS, GLASS, WHEELS AND TIRES.&#x20;

**BODY = 95 Editable Components**

**PARTS = 240 Editable Components**

**GLASS = 19 Editable Components**

**WHEELS = 16 Editable Components**

**TIRES = 5 Editable Components**

You may edit the values for each (or all) of the four repair methods of REPLACEMENT, REPAIR & REFINISH, REFINISH ONLY or PDR REPAIR (marked as N/A If not applicable) associated with each component.&#x20;

**Standard Labor Rate**&#x20;

Set your Standard Labor Rate to calculate the total labor cost for each repair. If you use multiple facilities with different labor rates, contact your PAVE Account Executive for additional options on how to have multiple custom damage tables.&#x20;

By toggling the **$TBD** switch on  for any repair type, this will set these items not to calculate a value and instead, these items get classified as repairs that require additional diagnostics and "$TBD" replaces the dollar amounts for these items.

**INFO/REPORT ITEMS**&#x20;

If you wish to identify some damage types as **"INFORMATION - REPORT ONLY"** such that no dollar value is assigned to the repair, set all values for that repair to $**0 LABOR and $0 PARTS & MATERIALS**. These items will be displayed in the Normal Wear and Tear section of your estimates, not under Excess Wear where all amounts are chargeable.

**Reset Values to Default**&#x20;

You can reset your entire wear and tear estimates back to the current default values at any time by clicking and confirming Reset Values to Default. These default values may also get updated by Discovery Loft over time which will only impact any values you have not edited and will not overwrite any values you have specifically set.


# Integrations


# vAuto

Instructions for connecting your vAuto account with PAVE

This easy 3-step integration process allows you to combine PAVE's vehicle capture, inspection, and grading process with vAuto Provision's market insights to make better inventory acquisition decisions and set the correct actual cash values on every trade and inventory acquisition opportunity.&#x20;

**Key Benefits:**

* Never manually key in another 17-character VIN. Now simply taking a photo of any VIN using PAVE will automatically populate it accurately in vAuto.
* Get actual mileage from a single photo captured by PAVE. Every PAVE inspection extracts the exact odometer reading from the vehicle, which is now automatically populated in vAuto.
* Every inspection in PAVE is now linkable to your appraisal in Provision in one click.
* Access PAVE's comprehensive condition report directly within vAuto from the URL included in the notes on each appraisal.

## Integrating vAuto Provision with your PAVE API Dashboard

**Step 1**: Call vAuto tech support at **1-877-828-8614** and select Option 2.&#x20;

{% hint style="info" %}
NOTE: For vAuto / PAVE integration,  please call vAuto Technical Support at the number above. Please **do not** contact your vAuto Performance Manager or Account Manager as they will not know how to complete this process.
{% endhint %}

**Step 2**: Advise them that you would like to complete a CRM integration with Discovery Loft's PAVE system and that you need them to set up an **Entity ID and Username**.

**Step 3:** Once you have been supplied with your Entity ID and Username, add this information on the PAVE dashboard inside Settings>Integrations

<figure><img src="/files/0OkQWtc6GNr4ZyBff4p2" alt=""><figcaption><p>Integrations - vAuto</p></figcaption></figure>

**Step 4**: Set your account as 'Active' (required)

<figure><img src="/files/weHItr3izLiqG4bkHEPq" alt="" width="350"><figcaption></figcaption></figure>

| MODE          | DESCRIPTION                                                                                                                                                                                               |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **AUTO SEND** | Whenever an inspection is completed, it will automatically appear on your vAuto Appraisal Dashboard                                                                                                       |
| **MANUAL**    | Inspections will not transfer automatically. You will have to log in to your PAVE dashboard and click the yellow "vAuto" link next to each inspection. Once it turns green, it has been received by vAuto |

<figure><img src="/files/IUq0p8tDg6QVwgxENFvO" alt=""><figcaption><p>vAuto Integration active, as seen on the PAVE Dashboard</p></figcaption></figure>

<figure><img src="/files/AYbtbGbHFbm9E6de9Wt9" alt=""><figcaption><p>vAuto Appraisal View</p></figcaption></figure>

#### Information passed from PAVE to vAuto

| Parameter               | Description                                   |
| ----------------------- | --------------------------------------------- |
| **VIN**                 | Vehicle VIN                                   |
| **Odometer**            | Odometer                                      |
| **Y/M/M/T/C**           | Year, Make, Model, Trim or Series, and Colour |
| **Appraiser**           | Identified as PAVE, inputted as "User, API'   |
| **Contact Name**        | 'Customer Information' field in vAuto         |
| **Reconditioning Cost** | 'Reconditioning' field in vAuto               |
| **PAVE Results Page**   | URL to the inspection results page            |


# Custom Capture

**Custom Content-Driven Photos**

The Custom Capture feature allows users to set up their desired custom content-driven photo capture flow based on their requirements for any specific API key within their account.&#x20;

If selected, this would add this customized capture flow to the end of the inspection capture process. The client can create an unlimited number of these flows that they can attach to any specific API key.

**Step 1: Activation on Your Account**

First, the feature must be activated for your business account. Please ask your Client Support Manager to activate this feature to your account.<br>

**Step 2: Setting up a Custom Capture Flow**

**PAVE Dashboard**&#x20;

To use this feature on the PAVE dashboard,  select the "CUSTOM CAPTURE" section inside "SETTINGS"

<figure><img src="/files/BVtYJCzCcXFe0kAfHYlX" alt=""><figcaption></figcaption></figure>

#### Video Tutorial on setting up a Custom Capture Questionaire.&#x20;

{% embed url="<https://www.youtube.com/watch?v=yLMRxsANkf0>" %}

<figure><img src="/files/cToGzi6qsORGQesaAZQH" alt=""><figcaption></figcaption></figure>

| Question Type | Description                                                                                          |
| ------------- | ---------------------------------------------------------------------------------------------------- |
| Yes/No        | Design a True or False response, and ask for a photo depending on the response, if required          |
| Text Entry    | The user is provided a text box to input their answer, and a photo attachment can also be requested. |
| Capture Photo | No response field. The user simply submits additional photos.                                        |

<figure><img src="/files/8E1oYIFwHLjzCwYpvJZM" alt=""><figcaption><p>Sample Yes/No Question</p></figcaption></figure>

**Step 3: Adding Custom Photo Capture Flow to API Key**

To setup the Custom Photo Capture, user can select in API-KEY section.

1. Select the "Inclue Custom Photo Capture Flow" in Create or Edit API Key
2. Select the Flow user desire.
3. Save Changes and everything will be ready.&#x20;

<figure><img src="/files/xKSy2m159C1ZRU8iIR5E" alt=""><figcaption></figcaption></figure>

**CaptureUI**

The end user will see the custom capture flow at the end of the inspection process. Below is a sample screenshot:

<figure><img src="/files/NxsL4u5COWYuuZT60sYQ" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/Fgv0PinWDYZW63hS9AH6" alt="" width="375"><figcaption></figcaption></figure>

<figure><img src="/files/mOKgSeioVS3nI0eUsRXq" alt="" width="375"><figcaption></figcaption></figure>

**API-Response**

```
"forms": {
        "data": {
            "exterior": {
                "do_you_have_a_roof_rail": true
            },
            "interiors": {
                "is_the_seatbelt_still_intact": true,
                "does_the_vehicle_have_leather_seats": false
            },
            "vehicle_information": {
                "make": "Volkswagen",
                "model": "Golf",
                "model_year": "2015"
            }
        },
        "attachments": {
            "exterior": {
                "do_you_have_a_roof_rail": [
                    {
                        "url": "https:\/\/openapi-cdn.paveapi.com\/sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41ca-0966-4c99-b670-6faf2742e53e.jpg",
                        "path": "sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41ca-0966-4c99-b670-6faf2742e53e.jpg",
                        "size": 1983370,
                        "filename": "user_form-9b0d41ca-0966-4c99-b670-6faf2742e53e.jpg",
                        "extension": "jpg"
                    },
                    {
                        "url": "https:\/\/openapi-cdn.paveapi.com\/sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41e1-8dc7-49d6-9ca2-52f21646e988.jpg",
                        "path": "sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41e1-8dc7-49d6-9ca2-52f21646e988.jpg",
                        "size": 1984286,
                        "filename": "user_form-9b0d41e1-8dc7-49d6-9ca2-52f21646e988.jpg",
                        "extension": "jpg"
                    }
                ]
            },
            "interiors": {
                "is_the_seatbelt_still_intact": [
                    {
                        "url": "https:\/\/openapi-cdn.paveapi.com\/sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41a9-33d6-4551-ac26-2fe9045597de.jpg",
                        "path": "sessions\/sessions\/2024-01\/UDB-I7JYMSFWMU\/forms\/user_form-9b0d41a9-33d6-4551-ac26-2fe9045597de.jpg",
                        "size": 2003328,
                        "filename": "user_form-9b0d41a9-33d6-4551-ac26-2fe9045597de.jpg",
                        "extension": "jpg"
                    }
                ]
            }
        }
```

#### Sample JSON

{% file src="/files/JF8qsY6Doq5GSBqMGjbd" %}


# Step by Step Guide

Step by Step guides to help you navigate through unique scenarios using PAVE


# Managing Unique User Sessions

Step by step guide to setting up a USER, such that the user can create and view sessions for their user account only

#### Step 1:  Initiate creating a [New User](/branch-dashboard/user-feature-walkthrough/settings/users/creating-a-new-user)

The first step is to create a new user (or update an existing one). \
\
Creating a new user can be done easily by selecting "Settings">"Users">"Create New User"&#x20;

<figure><img src="/files/rIfv8LWPDmn808w3GQRX" alt=""><figcaption><p>Create a New User</p></figcaption></figure>

#### Step 2: Add New User details

Add the Username, Full Name, and Email. Then select the 'USER' role and select the API keys that you would like this user to have access to.

<figure><img src="/files/2JV67DS78CgJDeGqzSrC" alt=""><figcaption><p>Add User Details</p></figcaption></figure>

{% hint style="info" %}
**Note:** Selecting the API-Keys grants access to this user to only create and view sessions from the selected API-Key(s).&#x20;
{% endhint %}

{% hint style="info" %}
This user will **not be** able to view sessions created by other users even if the other user has access to the same API-Key
{% endhint %}

#### Step 3:   Send log-in Credentials to the User

Send the user their account login credentials by generating a password and then clicking 'Save Changes' as shown below.&#x20;

<figure><img src="/files/SMRXEDpOmhU8MQVJ41zW" alt=""><figcaption><p>Send Email Credentials</p></figcaption></figure>

{% hint style="info" %}
Users can use log into their PAVE dashboard using the credentials here: <https://dashboard.paveapi.com/>
{% endhint %}

#### Step 4:  Access the 'User only' Dashboard View &#x20;

<figure><img src="/files/dVdqhJRa4r42BfXrmilm" alt=""><figcaption><p>Dashboard view for this User, with no other sessions visible from other users</p></figcaption></figure>

The user can now access the PAVE Branch Dashboard specific to the API-Keys that they have access to, with no other user's sessions visible on their dashboard.&#x20;

### Link a Sharable Link to a specific User

Finally, setting up Sharable Links unique to each user also ensures that the sessions created using that Sharable Link are visible to only that user.

#### Step 5: (Applicable if using Sharable Links)

Assign the USER to the required [Sharable Link](/branch-dashboard/user-feature-walkthrough/settings/widgets/sharable-links), in case Sharable Links are to be used to create sessions for this User's account.&#x20;

<figure><img src="/files/WYujHmlc89jBDZ8ldBUY" alt="" width="396"><figcaption><p>Assign the User to a Sharable LInk</p></figcaption></figure>

Doing so will show any sessions created by this Sharable Link inside only that User's branch dashboard, as shown below:

<figure><img src="/files/NaA1ESQ0TF7nXTgxNuf9" alt=""><figcaption><p>Session created by a Sharable Link assigned to that User can be seen inside only that User's dashboard</p></figcaption></figure>

{% hint style="warning" %}
**Important**: Please ensure that the USER has access to the particular API-Key which is assigned to that Sharable Link, else they would **not** be able to view sessions from that Sharable Link.
{% endhint %}

Following the steps outlined above will allow you to keep sessions created by different users separated and unique to that user.