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

Assets
Associates & Milestones
AUS Tracking
Audit Trail
- V3 Pull Loan Field Audit Datapost
Borrower Pair
Borrower Vesting
Batch Update
- V1 Get Statusget
- V1 Update Loanspost
Conversation Log
Disasters Collection
Disclosure Tracking (2015)
eFolder Documents
eFolder Attachments
eFolder Export Attachments
eFolder History
- V3 Get eFolder Historyget
Import from File
Liabilities
Loan Contacts
Loan Conditions
Loan Enhanced Conditions
Loan Folder
Loan Management
Loan Management (Reader / Writer)
Loan Pipeline
Non-Borrowing Owners
Rate Lock
Recipients
- V3 Contracts
- V3 Get Recipientsget
Registration Logs
Resource Lock
URLA Alternate Names
Verification Input Forms

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: 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: Loan Custom Fields
Settings: Loan Templates
Settings: HMDA Profiles
- V3 Get List of HMDA Profilesget
- V3 Get HMDA Profile Detailsget
Settings: Organizations
Settings: Personas
Settings: Policies
- V3 Get URLA Configurationget
Settings: Roles
- V1 Contracts
- V1 Get a List of Rolesget
Settings: Internal Users
Settings: SCIM Provisioning
Settings: SCIM Account Links
Tools: Loan Transformer
- Export Loan to MISMO 3.4get
Tools: Search
- Contracts
- Search for Field or Formpost
Tools: Transient Calculator
- V1 Contracts
- V1 Calculate Loanpost

Webhook

Overview
Resources
Subscriptions
Event History

Workflow Management

Overview
Task Configuration
Task Instance Management

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

Assets
Associates & Milestones
AUS Tracking
Audit Trail
- V3 Pull Loan Field Audit Datapost
Borrower Pair
Borrower Vesting
Batch Update
- V1 Get Statusget
- V1 Update Loanspost
Conversation Log
Disasters Collection
Disclosure Tracking (2015)
eFolder Documents
eFolder Attachments
eFolder Export Attachments
eFolder History
- V3 Get eFolder Historyget
Import from File
Liabilities
Loan Contacts
Loan Conditions
Loan Enhanced Conditions
Loan Folder
Loan Management
Loan Management (Reader / Writer)
Loan Pipeline
Non-Borrowing Owners
Rate Lock
Recipients
- V3 Contracts
- V3 Get Recipientsget
Registration Logs
Resource Lock
URLA Alternate Names
Verification Input Forms

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: 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: Loan Custom Fields
Settings: Loan Templates
Settings: HMDA Profiles
- V3 Get List of HMDA Profilesget
- V3 Get HMDA Profile Detailsget
Settings: Organizations
Settings: Personas
Settings: Policies
- V3 Get URLA Configurationget
Settings: Roles
- V1 Contracts
- V1 Get a List of Rolesget
Settings: Internal Users
Settings: SCIM Provisioning
Settings: SCIM Account Links
Tools: Loan Transformer
- Export Loan to MISMO 3.4get
Tools: Search
- Contracts
- Search for Field or Formpost
Tools: Transient Calculator
- V1 Contracts
- V1 Calculate Loanpost

Webhook

Overview
Resources
Subscriptions
Event History

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