Setting up Encompass for the connector

For your Encompass administrator. The connector signs in to your Encompass instance as a dedicated API user, through an API client. You create both; they're then entered on the connector's Encompass connection tab.

1. An API user

Create an Encompass user just for the connector, for example definitive.connector. A dedicated user means:

• its work shows under its own name in each loan's history;
• you can switch the connector off at any time by disabling the user;
• its password doesn't belong to a person, so staff changes don't break the connection.

Its persona needs to be able to:

• create loans in the loan folder you'll pick on the New loans tab, and read and edit loans: the connector writes the fields you map, the loan officer and the property state;
• see loans in the pipeline: before creating a loan, it looks for an active loan with the borrower's email;
• read settings: loan folders, loan templates, milestones, roles, users and their licenses (used by the connector's dropdowns and for loan officer assignment);
• manage its webhook subscription for loan events (made when you save the connection).

Your Encompass administrator grants these through the user's persona.

2. An API client (client ID and client secret)

The connector signs in through an API client created for your Encompass instance. Your Encompass administrator creates it and gets its client ID and client secret. If your company hasn't set one up before, ICE Mortgage Technology can help.

3. Instance ID and environment

• Instance ID: your Encompass instance, such as BE11234567. Test instances start with TEBE. Your Encompass administrator can confirm it.
• Environment: Production for your live instance, Test (UAT) for a test instance.

What the connector does in Encompass

• Creates loans when the workflow action runs, in the folder and with the template you chose.
• Writes only the fields you map, by field ID, in place on the loan's borrower.
• Assigns the loan officer through the loan officer role on the loan's first milestone that carries it.
• Reads loans to keep your CRM current: your mapped fields, plus the borrower's name and contact details, the subject property address, and the loan number, amount, purpose, milestone, status and loan officer.
• Subscribes to loan events (created, milestone, updated) for your instance, so changes reach the CRM quickly.

It never deletes loans, moves them between folders, or finishes milestones.

Changing the password or client secret

Enter the new value on the Encompass connection tab and choose Save and test. Leaving the password or client secret blank keeps the saved one; neither is ever shown again once saved.

Need help? Email support@definitiveconnector.com. We reply within 24 hours. Please don't send passwords, client secrets or borrower details such as Social Security numbers.