API Reference

Log In

Guides API Reference Release Notes

API Reference

Welcome
API Previews

Calculators: Encompass Calculators

Encompass Calculators

Consumer Engagement: Loan Opportunities

Scenario Management
Opportunity Notifications
- Send a Notification Requestget
Loan Opportunity Management
Document Management for an Opportunity
Loan Opportunity Selector
- Get Loan Opportunities with Searchget

Consumer Engagement: Loan Prospects

Prospect Engagement
- Create Invitation URLpost
- Create Reminder URLpost

Custom Data Objects (CDO)

Loan CDOs
User CDOs
Global CDOs

Document Delivery: Packages

Packages
- Get Packagesget
- Get Packageget

Document Delivery: Point of Sale Integration Framework

Point of Sale Integration Framework
- Package Event
  - Create a Package Eventpost
- Session
  - Create a Sessionpost

eFolder: Enhanced Conditions

Loan Enhanced Conditions

eFolder: Standard Conditions

Loan Conditions

Encompass Contacts

Borrower
Groups
Business

Encompass Docs: Add Documents to a Package

Send Encompass Docs Overview
Add Documents to a Package
- Opening Package
  - Add to Opening Doc Setpost
  - Get Opening Doc Setget
- Closing Package
  - Add to Closing Doc Setpost
  - Get Closing Doc Setget

Encompass Docs: Audit Loan File

Audit Loan File

Encompass Docs: Generate Document Package

Generate Document Package

Encompass Docs: Manage Plan Codes

Manage Plan Codes
- Apply Plan Codepost
- Get Plan Codesget

Encompass Docs: Print on Demand

Print on Demand
- Generate a Print Orderpost
- Get a Print Orderget

Encompass Docs: Send Document Package

Send Document Package

Encompass Loan

eFolder Documents
eFolder Attachments
eFolder Export Attachments
eFolder History
- V3 Get eFolder Historyget
Recipients
- V3 Contracts
- V3 Get Recipientsget

Encompass Personalization

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

Loan Funding

Manage Funding Fees
- V3 Get Funding Feesget
- V3 Update Funding Balancespatch
Manage Funding Balances
- V3 Get Funding Balancesget

Loan: Borrower Pair Management

Borrower Pair Management

Loan: Disclosure Tracking Logs

Disclosure Tracking (2015)

Loan: Entities Management

Non-Borrowing Owners
- V3 Get Non-Borrowing Ownersget
- V3 Manage Non-Borrowing Ownerspatch
Borrower Vesting
- V3 View Vesting Entitiesget
- V3 Manage Vesting Entitiespatch
Disasters Collection
- V3 Get Disastersget
- V3 Manage Disasterspatch
Field Lock Data
- V3 Update Field Lock Datapatch
Home Counseling Providers
- V3 Get Home Counseling Providerget
- V3 Manage Home Counseling Providers Listpatch

Loan: File Contacts

Loan Contacts
- Affiliated Business Arrangements
  - V3 Get Affiliated Business Arrangementsget
  - V3 Manage Affiliated Business Arrangementspatch
- Service Provider Contacts
  - V3 Get Service Provider Contactsget
  - V3 Manage Service Provider Contacts Listpatch

Loan: Loan Management

Audit Trail
- V3 Pull Loan Field Audit Datapost
Batch Update
- V1 Get Statusget
- V1 Update Loanspost
Import from File
Loan Management
Loan Management (Reader/Writer)
URLA Alternate Names

Loan: Loan Metadata

Loan Metadata
- V1 Get Loan Metadataget

Loan: Loan Pipeline

Loan Pipeline
- V3 Loan Pipeline
- V1 Loan Pipeline

Loan: Loan Tracking Logs

AUS Tracking
Conversation Log
Registration Logs

Loan: Loan Verifications

Verification Input Forms
Assets
Liabilities
- V3 Get Other Liabilitiesget
- V3 Manage Other Liabilitiespatch

Loan: Milestones and Associates

Associates & Milestones

Loan: Rate Lock

Rate Lock Requests

Loan: Resource Lock

Loan Resource Lock

Request for Transcript of Tax

Request for Transcript of Tax
- Preview: V3 Get Request for Transcript of Taxget
- V3 Update Request for Transcript of Taxpatch

Secondary Marketing: Trade Management

Trade Pipeline
- Get Trade Pipelinepost
- Get Field Definitionsget
Correspondent Trades
Loan Trades
Trade Documents

Services: Partner Service Orders

Service Orders

Services: ICE Product and Pricing Engine (ICE PPE)

Overview
User Management
- Get User Mappingget
- Map ICE PPE Userpatch
Rates
Guidelines
- Get Guideline Detailsget
Lookups

Services: Encompass Compliance Service

Encompass Compliance Service
- Create Compliance Reportpost
- Get Compliance Reportget

Settings: Company/User Setup

Milestones
- V3 Get List of Milestonesget
- V3 Get Details on Specific Milestoneget
Organizations
Personas
Roles

Settings: Contact Setup

Borrower Contacts
- V1 Get Borrower Canonical Namesget
Business Contacts

Settings: eFolder Setup

eFolder Setup

Settings: Encompass Compliance Service Setup (ECS)

Manage Compliance Report Settings
- Manage Compliance Settings Report Permissionspost

Settings: Encompass Schemas

Schemas
Contract and Path Generators
- V1 Path Generatorpost
- V1 Contract Generatorpost
Loan Entities
- V1 Get Supported Entitiesget

Settings: External Company Setup

Company Details
TPO Settings
TPO Custom Fields
- V3 Get TPO Custom Field Definitionsget
TPO Fees
Warehouse Banks
- V3 Get External Banksget

Settings: External User Setup

Manage External Users

Settings: Internal User Management

V3 Internal Users
V1 Internal Users

Settings: Loan Opportunity Setup

Affordability
Email Template Management
Feature Management
Letter Template Management

Settings: Loan Setup

Disclosure Tracking
- V3 Get Disclosure Tracking Settingsget
HMDA Profiles
- V3 Get List of HMDA Profilesget
- V3 Get HMDA Profile Detailsget
Enhanced Conditions
Loan Custom Fields
Loan Folder
- V3 Get List of Loan Foldersget
- V3 Get a Loan Folderget
Loan Print Forms
Policies
- V3 Get URLA Configurationget

Settings: Loan Templates

Overview
Closing Cost Templates
- V3 Get List of Closing Cost Templatesget
- V3 Get Closing Cost Template Settingsget
Loan Program Templates
- V3 Get List of Loan Program Templatesget
- V3 Get Loan Program Template Settingsget
Settlement Service Provider Templates
- V3 Get List of Settlement Service Provider Template Foldersget
- V3 Get Details of a Settlement Service Provider Template Fileget
Transcript of Tax Templates
- V3 Get List of Transcript of Tax Templatesget
- V3 Get Transcript of Tax Templateget
Loan Template Sets

Settings: SCIM Provisioning & Account Linking

Overview
Manage SCIM Users
Manage SCIM Groups
Manage SCIM Account Links

Settings: Secondary Setup

Secondary Setup

Settings: Tables and Fees

Fee Management

Settings: Workflow Task Configuration

Overview
Manage Task Templates
Manage Subtask Templates
Manage Task Settings
- Get Task Settingsget
- Update Task Settingsput

Tools: Loan Transformer

Export Loan
- Export Loan to MISMO 3.4get

Tools: Search

Search for Field or Form
- Search for Field or Formpost

Webhooks: Overview

Overview
Resources and Events
Retry Logic
Access Controls
Custom Authentication
Signing Keys
Endpoint Requirements
Webhook Event Payload Attributes

Webhooks: Resources & Subscriptions

Resources
Subscriptions

Webhooks: Event History

Event History
- Get All Eventsget
- Get an Eventget

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: Task Instance Management

Overview
Manage Tasks
Manage Sub-Tasks
Task Pipeline
- Get Task Pipelineget

Loan Pipeline Views

Use these APIs to create and manage user loan pipeline views.

Updated about 2 hours ago