Encompass: API Provisioning Process

The Encompass API token lets Big Purple Dot access certain data in your Encompass account. We'll ask ICE Mortgage Technology for permission, which might take up to 5 business days. They'll generate a special access token just for your Encompass Instance. Once the API token is authorized, we'll need your Encompass admin to set up the API user with the Token.

Here's what we'll need to get the API token authorization:

• Encompass Instance ID (Client ID) 
• Encompass Administrator's email address 

Please send this info to [e-mail] to start the Encompass integration.

Setting up the API User in Encompass

Once ICE authorizes the API token, follow these simple steps to create an API user in your Encompass instance:

• Go to Settings > Organization/Users > click on Add User
• Create a new user by adding the Big Purple Dot API Client ID. Check the API User checkbox and fill in the other required fields:
  
  • User ID (e.g., BPDintegration) 
  • First Name
  • Last Name
  • Email ([e-mail]) 
• Click 'Save' when finished.

• Now, set the access control for the API user in Persona settings:

  • Select the Access tab.

  • Under Encompass Access, choose 'Both Microsoft Windows Encompass Client and Encompass Mobile (LO Connect™️) in a web browser'.

⚠️ Important: Remember, you need to follow these steps for every Encompass instance (both test and production environments) that Big Purple Dot will access.