Create an API User in Encompass

In order for lenders to take advantage of Blend’s API-based integration with Encompass, user administrators at a lender will need to create an API user in their instance of Encompass that will act as the communicator between Blend’s integrations layer and the lender. See below for instructions on this process.

Step 1: Blend provides lender an API Client ID that lender administrator will use when creating a user

The Blend point of contact will provide the lender point of contact with a client_id (or API Client ID). This is part of an authentication protocol that Ellie Mae has issued Blend in order to access Next Gen APIs on the lender’s behalf. 

Example: client_id = rmsgpbp

Step 2: Lender administrator navigates to Settings > Organization/Users in Encompass

Step 3: Lender administrator clicks green plus icon to create new user

Step 4: Lender administrator enters user details

Click the API User checkbox within the User Details modal. At that point, you’ll see some of the required information change from a traditional lender user. In the User ID, enter blendapiuser or another name that makes sense to you. In the API Client ID field, enter the client ID that the Blend point of contact provided. Match the First Name, Last Name, and Email fields to the image below. Blend recommends creating a separate persona for this user. See below for more information on that. Save the user.

Persona for the Blend API User

As a best practice, Blend recommends creating 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 recommends adding the following permissions to the Blend API User persona. This is a best practice recommendation; if a lender has their own preferences for creating a persona, it’s fine to start with that. We can revisit this if any permission issues arise in the integration.

Pipeline

Pipeline Tasks

Pipeline Tasks cont’d

Loan

Other

Other cont’d

Other cont’d

Itemization Fee Management – all items checked 

Forms/Tools

Input Forms – all items checked

Tools – all items checked

eFolder

General

General cont’d

General cont’d

 

General cont’d

General cont’d

Unprotected Documents – all items checked

Unassigned Files (File Manager)

Unassigned Files (File Manager) cont’d

Unassigned Files (File Manager) cont’d

Unassigned Files (File Manager) cont’d

Protected Documents – all items checked

Conditions – all items checked

Trades/Contacts/Dashboard/Reports

Trades – no items checked

Dashboard – no items checked

Contacts – all items checked

Reports – no items checked

Settings

Company Settings – no items checked

Personal Settings – no items checked

Other – no items checked

External Settings

External Settings – no items checked

Consumer Connect and LO Connect – no items checked