Unanet: API Set-Up Guide

Last updated: June 2, 2026

Currently, our team at Kantiv manages the configuration and maintenance of your integration directly. To establish a new connection or adjust your existing setup, please reach out to Integrations@kantiv.com. These management tools are part of our roadmap and will be available for self-service in a future release.

Overview

To allow Kantiv to securely access your Unanet data, you must create a dedicated API user, assign the correct permissions, and generate a unique API key. This guide walks you through the entire process.


Prerequisites

You must have Administrator access to your Unanet instance.


Step-by-Step Configuration

Step 1: Create a Dedicated Integration User

Create a new user in Unanet that will be used exclusively for the Kantiv integration. This ensures all API activity is isolated and traceable.

  1. Navigate to Administration > People > +Person.

  2. Fill in the required user details. We recommend using a clear and specific Username, such as kantiv_integration or api_kantiv.

  3. Assign a strong, unique password for this user.

Important: Securely record the Username and Password. You will need to provide these to Kantiv.

4. Save the new user.


Step 2: Assign Required Permissions

For the integration to function, the new user must have specific permissions. These are typically assigned via Unanet Roles.

  1. Navigate to Administration > Setup > Roles.

  2. You can either (a) add the required permissions to an existing custom API role or (b) create a new role (e.g., "Kantiv API Access").

  3. Ensure the role assigned to your new user (`kantiv_integration`) includes at least the following permissions:

    1.  API Management - Allows the user to authenticate via the API.

    2.  Data Dictionary - Allows the integration to understand your data structure.

    3.  Data Access - In addition to the permissions above, this user must also have roles that grant access to the specific data Kantiv needs to read or write (e.g., access to Projects, Tasks, Time, Expenses, etc.). Assign the appropriate data-level roles as required by the integration.


Step 3: Identify Your Firm Access Code

The Firm Access Code is required for the integration to target your specific Unanet instance.

Your Firm Code is usually a numeric value you enter when logging into the Unanet platform or the first part of your Unanet URL.


Step 4: Generate a New API Key

  1. Navigate to Administration > API Management > Manage Keys.

  2. Click the + API Key icon to create a new key.

  3. In the User field, select the integration user you created in Step 1 (e.g., kantiv_integration).

  4. Enter a clear Description (e.g., "Kantiv Integration Key").

  5. Click Save.

Unanet will display the API Key one time only. Copy this key immediately and store it securely. If you lose this key, you must generate a new one.


Required Credentials

Once you have completed all the steps, please securely provide the following four pieces of information to your Kantiv implementation team:

Name

Integration Configuration Details

Authentication Credentials

  • Username: The username created in Step 1

  • Password: The password for the user created in Step 1

  • API Key: The long key generated in Step 4

Base URL

  • Optional. Override the default API base endpoint if needed.

Firm Access Code

  • Usually a number identifying your Unanet instance


You can always find more information on Security and Integrations on our Support Center. Please send any questions or feedback to Integrations@Kantiv.com.