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

Encompass Contacts

Borrower
Groups
Business

Encompass Docs

Send Encompass Docs
Print On Demand

Encompass Loan

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 Fields
Custom Data Objects
Settings: Disclosure Tracking
- V3 Contracts
- V3 Get Disclosure Tracking Settingsget
Settings: Documents
- V3 Get eFolder Document Settingsget
- V3 Get eFolder Document Optionsget
Settings: External Organizations
Settings: External Users
Settings: Fee Management
- V3 Get Itemization Fee Managementget
- V3 Get Loan Originator Compensation Plansget
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

Point of Sale Integration Framework

Contracts
Create a Package Eventpost
Create a Sessionpost

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

Encompass Contacts

Borrower
Groups
Business

Encompass Docs

Send Encompass Docs
Print On Demand

Encompass Loan

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 Fields
Custom Data Objects
Settings: Disclosure Tracking
- V3 Contracts
- V3 Get Disclosure Tracking Settingsget
Settings: Documents
- V3 Get eFolder Document Settingsget
- V3 Get eFolder Document Optionsget
Settings: External Organizations
Settings: External Users
Settings: Fee Management
- V3 Get Itemization Fee Managementget
- V3 Get Loan Originator Compensation Plansget
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

Point of Sale Integration Framework

Contracts
Create a Package Eventpost
Create a Sessionpost

Schema

A schema specifies the entities and data elements in a loan resource. You can retrieve all schema information from a loan or a certain set specified by field ID.