Jump to Content

Download Postman Collection

Guides API Reference Release Notes

Download Postman Collection Log In

API Reference

Guides API Reference Release Notes

API Reference

Welcome
API Previews

Consumer Engagement

Loan Opportunity Settings
Loan Opportunity Management
Document Management for an Opportunity
Loan Opportunity Selector
- Get Loan Opportunities with Searchget
Prospect Engagement

DOCUMENT DELIVERY

Packages
- Get Packagesget
- Get Packageget
Point of Sale Integration Framework

Encompass Contacts

Borrower
Groups
Business

Encompass Docs

Send Encompass Docs
Print On Demand

Encompass Loan

ENCOMPASS SCHEMA

Schema

ENCOMPASS PERSONALIZATION

Loan Pipeline Views
- Preview: V3 Create Pipeline Viewpost
- Preview: V3 Update Pipeline Viewpatch

Secondary and Trades

Correspondent Trades
Secondary

Services

Encompass Compliance Service
ICE Product and Pricing Engine (ICE PPE)
Partner Services

Settings and Utilities

Custom Data Objects
Settings: Business Contacts
Settings: Compliance Reports
- Contracts
- Manage Compliance Settings Report Permissionspost
Settings: Disclosure Tracking
- V3 Contracts
- V3 Get Disclosure Tracking Settingsget
Settings: Documents
Settings: Enhanced Conditions
Settings: External Organizations - Banks
- V3 Get External Banksget
Settings: External Organizations - TPOs
Settings: External Organizations - TPO Settings
Settings: External Users
Settings: Fee Management
- V3 Get Itemization Fee Managementget
- V3 Get Loan Originator Compensation Plansget
Settings: HMDA Profiles
- V3 Get List of HMDA Profilesget
- V3 Get HMDA Profile Detailsget
Settings: Internal Users
Settings: Loan Custom Fields
Settings: Loan Print Forms
Settings: Loan Templates
Settings: Milestones
- V3 Get List of Milestonesget
- V3 Get Details on Specific Milestoneget
Settings: Organizations
Settings: Personas
Settings: Policies
- V3 Get URLA Configurationget
Settings: Roles
Settings: SCIM Provisioning
Settings: SCIM Account Links
Tools: Loan Transformer
- Export Loan to MISMO 3.4get
Tools: Search
- Contracts
- Search for Field or Formpost

Webhook

Overview
Resources
Subscriptions
Event History

Webhook Custom Auth Configuration

Overview
Create Webhook Custom Auth Function
- Create Webhook Custom Auth Functionpost
- Get Webhook Custom Auth Function Listget
Manage Webhook Custom Auth
Manage Custom Auth Linking to Webhook Subscription
Test Webhook Custom Auth
- Test Webhook Custom Auth Parameterspost

Workflow Management

Overview
Task Configuration
Task Instance Management

V3 Get Effective Rights of External User

get https://api.elliemae.com/encompass/v3/externalUsers/{userId}/effectiveRights

Returns information about the effective rights of a specified TPO user.

Language

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use