Lender Toolkit will respond to client's API credential request when the credentials are generated by ICE. The API Client ID is required when creating the API User.
LTK recommends creating a specific Persona for the API user. Below are the recommended Persona settings for API users. The API user with this persona requires access to all loans in the instance where any of Lender Toolkit's tools or automations may run. The user also needs permissions to perform edits and updates to virtually any area in the loan. Therefore the permissions below grant that access, without requiring granting the API user the Super Administrator persona. The permissions below are recommendations only. The LTK API User persona can be modified to meet each organization's security and access policies, with the understanding that some of Lender Toolkit's tools and automations may not be able to perform as expected.
Admin Setup – API User
Please note that the API versions of our PowerTools and automations require an API user to be created in each instance where the PowerTools™ are installed. Lender Toolkit can submit a request to ICE to generate the Client ID and secret key pair. If credentials have not yet been obtained, use the link below to request credentials.
Request API Credentials for PowerTools and Automations
Lender Toolkit will forward the API Client ID when received from ICE. Use the API Client ID to create an API user in the Encompass instance. Assign the API user the persona described below.
Follow the steps below to create the LTK API User persona, and assign to the API user.
1. Create an Encompass Persona for LTK API
2. On the Access tab, check "
Both desktop and web versions..."
3. Required Pipeline Tab Settings
4. Required Loan Tab Settings
5. Required Forms/Tools Tab Settings (None Needed)
6. Required eFolder Tab Settings
7. Required Enhanced Conditions Tab Settings (None Needed)
8. Required Trades/Contacts/Dashboard Reports Tab Settings (None Needed)
9. Required Settings Tab Settings (None Needed)
10. Required External Settings Tab Settings (None Needed)
11. Required Consumer Connect Tab Settings (None Needed)
12. Required eVault Tab Settings (None Needed)
13. Required Web Version Tab Settings - Pipeline Default of Loan Pipeline
14. Required Developer Connect Tab Settings
Next, create the API User. Detailed instructions from ICE for adding users in general, and API Users, are 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.
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:
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.
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.
