Setting Up the API User and Persona


Step 1: Request API credentials

The API versions of Lender Toolkit's PowerTools and automations need an API user in every Encompass instance where they will be installed. Lender Toolkit asks ICE to generate the Client ID and secret key for that user.  If you don't have credentials yet, request them here:


Lender Toolkit will contact you once ICE has generated the credentials.

Step 2: Assign the Administrator persona to the API user (recommended)


We recommend assigning the API user the Administrator persona. The API user does not require the Super Administrator persona.

The Administrator persona is recommended because the API user must be able to:

  • Access every loan in the instance where Lender Toolkit's tools or automations may run
  • Edit and update nearly every area of the loan
  • Lender Toolkit's current PowerTools and automations need this access across the whole loan workflow, and future releases will too.
    With the Administrator persona, new tools work without you having to change persona settings each time.
Alternative: Create a dedicated "LTK API User" persona

If your security policies don't allow assigning the Administrator persona to an API user, create a separate persona (for example, "LTK API User"). Then use the screenshots below to grant that persona access to every available persona setting.

You can change this persona to fit your organization's security and access policies. However, if you restrict any setting, some of Lender Toolkit's tools and automations may not work as expected, either now or when new tools are released.


Create the API User


Detailed instructions from ICE for adding API Users is located here: ICE - Adding Users

Administrators can also follow these steps below:

1. The API user needs to have access to all loans in the instance. We recommend placing the API user in the top level of the Hierarchy. Select a folder high enough in the organizational hierarchy that provides the appropriate access to loans for the integration. Typically, a folder just below the Administration folder or a folder for service accounts in the organizational hierarchy. After selecting the folder to house the API user, select Add User in the bottom right hand corner.
Image Placeholder

2. LTK recommends using API in the User ID field to easily identify API users when viewing the user list.
Note that when API User box is checked on the User Details screen, the username and password fields are replaced with API Client ID. This is where LTK’s API Client ID is entered. This information has been provided to the company admin. The required fields are shown here: 
Image Placeholder

3. Be sure to review the Access to Subordinates’ Loans settings, which are also on the User Details screen, to ensure the user will have the access to the loans needed for the integration. Note if view only access is sufficient, it should be selected here. 
Image Placeholder

4. Assign the “LTK API Persona” to the API User created earlier in this document.
5. Assign the user to a Group that gives the user access to all loans in the system.

For any additional questions or if further assistance is needed, please reach out to our Support Desk at support@lendertoolkit.com.