In order for lenders to take advantage of Blend’s new Blend-Encompass integration, user administrators at the lender will need to create an API user in their Encompass instance. This will act as interface between Blend and their Encompass instance
1. Blend provides lender an API Client ID that lender administrator will use when creating a user.
Note: Your Blend point of contact will provide you a client_id (or API Client ID). This is part of an authentication protocol that Ellie Mae has issued Blend in order to access Ellie Mae’s APIs on your behalf.
Example: client_id = rmsgpbp
Next-gen clients need to have Developer Connect configured and enabled in Encompass or API user will need access to Developer Connect. If they don't have access to Developer Connect, verification will fail on the Blend side.
2. Click Settings under the Encompass tab.
a. Click Company/Usersetup under the Settings Overview.
b. Click Organization/Users.
3. Click the green plus icon to create a new user.
4. Enter user details.
a. Click the API User checkbox.
Note: At that point, you’ll see some of the required information change from a traditional lender user.
b. For User ID, enter blendapiuser or another name that makes sense to you. Enter the API Client ID that the Blend point of contact provided.
c. Match the First Name, Last Name, and Email fields to the image above.
Note: Blend recommends creating a separate persona for this user. See below for more information on that.
d. Click Save.
5. Please send your Blend Account Manager an email letting them know you successfully completed steps 1-4 in order to ensure the new integration is enabled.
Persona for the Blend API User
As a best practice, Blend very strongly recommends giving the API user similar role permissions to that of an Admin persona. This ensures there are no permission roadblocks during implementation and allows for uninterrupted integration cohesion with product development. Credentials for this user are encrypted and cannot be accessed by almost anyone.
If similar role permissions to an Admin user are not desired; you can create a new persona for this API user called “Blend API User.” By creating a separate persona for the API user, you limit the risk of conflicting and changing permissions with other users. Blend however recommends adding the following permissions to the Blend API User persona.
Pipeline - Pipeline Tasks
Loan - Other/Itemization Fee Management
- Make sure to select the checkbox for "Change URLA Form Version" to avoid any export errors.
- Itemization Fee Management - all items checked.
- Input Forms - all items checked.
- Tools - all items checked.
eFolder - General
eFolder - Unprotected Documents
Note: Unprotected Documents – all items checked
eFolder - Unassigned Files (File Manager)
eFolder - Protected Documents
Note: Protected Documents – all items checked
eFolder - Conditions
Note: Conditions – all items checked
- Trades – no items checked
- Dashboard – no items checked
- Contacts – all items checked
- Reports – no items checked
- Company Settings – no items checked
- Personal Settings – no items checked
- Other – no items checked
Note: Both Microsoft Windows Encompass Client and Encompass Mobile (LO Connect) in a web browser - selected.
Note: You will need Developer Connect in your Encompass instances. The API user will need access to Developer Connect. If you don't have API user access, you will not be able to move forward.
Please contact email@example.com if you’d like to walk-through your set up in Encompass
DISCLAIMER: All mentioned features on this page may not be applicable to your institution, please reach out to (firstname.lastname@example.org) for more information on what features are enabled for your use.