Jump to Content
Download Postman Collection
Guides
API Reference
Release Notes
Download Postman Collection
Log In
API Reference
Log In
Guides
API Reference
Release Notes
Policies
Search
JUMP TO
API Reference
Welcome
API Previews
Consumer Engagement
Loan Opportunity Settings
Contracts
Affordability
Get Affordability Qualification Settings
get
Create Affordability Qualification Settings
post
Update Affordability Qualification Settings
put
Delete an Affordability Qualification
del
Email Template Management
Get Email Template
get
Create Email Template
post
Get Email Template Details
get
Update Email Template
put
Delete an Email Template
del
Feature Management
Get Feature Management Settings
get
Create New Feature
post
Update a Feature Management Setting
patch
Update a Feature
put
Delete a Feature Management Setting
del
Letter Template Management
Get List of Letter Templates
get
Get Letter Template Details
get
Create a Letter Template
post
Update Letter Template
put
Delete Letter Template
del
Loan Opportunity Management
Contracts
Get All Scenarios
get
Get a Scenario
get
Create a Scenario
post
Update a Scenario
put
Updates a Scenario
patch
Delete a Scenario
del
Convert Scenario to Loan
get
Send a Notification Request
post
Get a Loan Opportunity
get
Get Loan Opportunities
get
Create Loan Opportunity
post
Update Loan Opportunity
patch
Replace Loan Opportunity
put
Delete Loan Opportunity
del
Convert Loan Opportunity
post
Document Management for an Opportunity
Contracts
Get a Document
get
Create a Document
post
Update a Document
patch
Loan Opportunity Selector
Get Loan Opportunities with Search
get
Prospect Engagement
Contracts
Create Invitation URL
post
Create Reminder URL
post
DOCUMENT DELIVERY
Packages
Get Packages
get
Get Package
get
Point of Sale Integration Framework
Contracts
Create a Package Event
post
Create a Session
post
Encompass Contacts
Borrower
V1 Contracts
Link Borrower Contacts to a Loan
V1 Get Borrower Contact List
post
V1 Get a Borrower Contact
get
V1 Get Borrower Canonical Names
get
V1 View Borrower Contacts (with Pagination)
post
V1 Create Borrower Contact
post
V1 Update Borrower Contact
patch
V1 Delete Borrower Contact
del
V1 Get All Notes for a Borrower Contact
get
V1 Get a Note for a Borrower Contact
get
V1 Create a Note for a Borrower Contact
post
V1 Update a Note for a Borrower Contact
patch
V1 Delete a Note for a Borrower Contact
del
Groups
V1 Contracts
V1 Get All Contact Groups
get
V1 Get a Contact Group
get
V1 Get All Contacts in Contact Group
get
V1 Create Contact Group
post
V1 Add or Remove Group Contacts
patch
V1 Update a Contact Group
patch
V1 Delete a Contact Group
del
Business
V1 Contracts
Link Business Contacts to a Loan
V1 Get Business Contact List
post
V1 Get a Business Contact
get
V1 Get Business Contact Canonical Names
get
V1 View Business Contacts (with Pagination)
post
V1 Create a Business Contact
post
V1 Update a Business Contact
patch
V1 Delete a Business Contact
del
V1 Get a Note for a Business Contact
get
V1 Create Note for a Business Contact
post
V1 Update Note for a Business Contact
patch
V1 Delete Note for a Business Contact
del
Encompass Docs
Send Encompass Docs
Contracts
Manage Plan Codes
Apply Plan Code
post
Get Plan Codes
get
Audit Loan File
Create Loan Audit for Opening Order
post
Create Loan Audit for Closing Order
post
Get Document Audit for Opening Order
get
Get Document Audit for Closing Order
get
Generate Document Package
Generate Opening Doc Set
post
Generate Closing Doc Set
post
Generate Forms
post
Get Opening Order Status
get
Get Closing Order Status
get
Add Documents to a Package
Add to Opening Doc Set
post
Get Opening Doc Set
get
Add to Closing Doc Set
post
Get Closing Doc Set
get
Send Document Package
Send Opening Package
post
Send Closing Package
post
Send Forms
post
Get Opening Package Delivery Details
get
Get Closing Package Delivery Details
get
Get Forms Delivery Details
get
Print On Demand
Contracts
Generate a Print Order
post
Get a Print Order
get
Encompass Loan
Assets
V3 Contracts
V3 Get Other Income
get
V3 Manage Other Incomes
patch
V3 Get Other Assets
get
V3 Manage Other Assets
patch
V3 Get Gifts and Grants
get
V3 Manage Gifts and Grants
patch
V3 Get REO Properties
get
V3 Manage REO Properties
patch
Associates & Milestones
V3 Contracts
V3 Get Milestone Logs List
get
V3 Get Milestone Log
get
V3 Update Milestone Log
patch
V3 Get Milestone Free Role List
get
V3 Update Milestone Free Role
patch
V3 Update Milestone Dates
patch
V1 Contracts
V1 Get List of Associates
get
V1 Assign a Loan Associate
put
V1 Get All Milestones
get
V1 Get All Milestone Free Roles
get
V1 Get an Associate
get
V1 Get a Milestone
get
V1 Update a Milestone
patch
V1 Get a Milestone Free Role
get
V1 Update a Milestone-Free Role
patch
Audit Trail
V3 Pull Loan Field Audit Data
post
Borrower Pair
V1 Contracts
V1 Get All Borrower Pairs
get
V1 Get a Borrower Pair
get
V1 Create Borrower Pair
post
V1 Update Borrower Pair
patch
V1 Delete Borrower Pair
del
V1 Move Borrower Pair
patch
Borrower Vesting
V3 Contracts
V3 View Vesting Entities
get
V3 Manage Vesting Entities
patch
Batch Update
V1 Get Status
get
V1 Update Loans
post
Calculators
Loan Calculations
V1 Contracts
V1 Calculate Loan
post
Print Form Calculators
V3 Contracts
V3 Generate List of Standard Print Forms for a Loan
post
Compliance Calculator
V3 Contracts
V3 Compliance Calendar Date Calculator
post
Disasters Collection
V3 Contracts
V3 Get Disasters
get
V3 Manage Disasters
patch
eFolder Documents
V3 Contracts
V3 Get List of Documents
get
V3 Get a Document
get
V3 Manage Documents
patch
V3 Assign Document Attachments
patch
V3 Add Comments to a Document
patch
V1 Contract
V1 Get List of Documents
get
V1 Get a Document
get
V1 Get Document Attachments
get
V1 Create Document
post
V1 Update Document
patch
V1 Assign Document Attachments
patch
eFolder Attachments
V3 Contracts
V3 Get List of Attachments
get
V3 Get an Attachment
get
V3 Update or Remove Attachments
patch
V3 Create Attachment URL
post
V3 Get Download Attachment URL
post
V1 Contracts
V1 Get List of Attachments
get
V1 Get an Attachment
get
V1 Get Attachment Metadata
get
V1 Upload Attachment to eFolder
put
V1 Get Attachment from eFolder
post
V1 Get Thumbnail of Page
post
V1 Get Page of Attachment
post
V1 Update Attachment
patch
eFolder Export Attachments
Contracts
Get Export Status
get
Export Attachments
post
Export Files Job Creator
post
eFolder History
V3 Get eFolder History
get
Import from File
V3 Converter to Import New Loan
post
V3 Importer to Update Loan
post
V1 Loan Importer to Create Loan
post
Liabilities
V3 Contracts
V3 Get Other Liabilities
get
V3 Manage Other Liabilities
patch
Loan Contacts
V3 Contracts
V3 Get Affiliated Business Arrangements
get
V3 Manage Affiliated Business Arrangements
patch
V3 Manage Service Provider Contacts List
patch
V3 Get Service Provider Contacts
get
V3 Get Home Counseling Provider
get
V3 Manage Home Counseling Providers List
patch
Loan Conditions
V1 Contracts
V1 Get an Underwriting Condition
get
V1 Get All Underwriting Conditions
get
V1 Create Underwriting Conditions
post
V1 Manage Underwriting Conditions
patch
V1 Manage Underwriting Comments
patch
V1 Manage Underwriting Documents
patch
V1 Get All Preliminary Conditions
get
V1 Get a Preliminary Condition
get
V1 Create Preliminary Conditions
post
V1 Manage Preliminary Conditions
patch
V1 Manage Preliminary Comments
patch
V1 Manage Preliminary Documents
patch
V1 Get All Post-Closing Conditions
get
V1 Get a Post-Closing Condition
get
V1 Create Post-Closing Conditions
post
V1 Manage Post-Closing Conditions
patch
V1 Manage Post-Closing Comments
patch
V1 Manage Post-Closing Documents
patch
Loan Enhanced Conditions
V3 Contracts
V3 Get All Enhanced Conditions
get
V3 Get an Enhanced Condition
get
V3 Manage Enhanced Conditions
patch
V3 Get Comments
get
V3 Manage Comments
patch
V3 Get Documents
get
V3 Manage Documents
patch
V3 Get Tracking Entries
get
V3 Manage Tracking Entries
patch
Loan Management
V3 Get Loan
get
V3 Create Loan
post
V3 Update Loan
patch
V3 Delete Loan
del
V3 Get UCD Fields
get
V1 Get Loan
get
V1 Get Supported Entities
get
V1 Create Loan
post
V1 Move Loan to Folder
patch
V1 Delete Loan
del
V1 Update Loan
patch
Loan Management (Reader / Writer)
V3 Contracts
V3 Field Reader
post
V3 Field Writer
post
V3 Update Field Lock Data
patch
V1 Contracts
V1 Field Reader
post
Loan Pipeline
V3 Contracts
V3 Loan Pipeline for Reports
post
V3 Loan Pipeline (with Pagination)
post
V3 Get Pipeline Canonical Names
get
V1 Contracts
V1 Get Pipeline Canonical Names
get
V1 Create Cursor
post
V1 Loan Pipeline (with Pagination)
post
V1 Loan Pipeline
post
Non-Borrowing Owners
V3 Contracts
V3 Get Non-Borrowing Owners
get
V3 Manage Non-Borrowing Owners
patch
Rate Lock
V1 Contracts
V1 Get All Rate Lock Requests
get
V1 Get a Rate Lock Request
get
V1 Get Snapshot of a Rate Lock Request
get
V1 Submit a Rate Lock Request
post
V1 Update a Rate Lock Request
patch
V1 Confirm a Rate Lock Request
put
V1 Cancel Lock Request
put
V1 Deny a Rate Lock Request
put
V1 Void a Rate Lock Request
put
Recipients
V3 Contracts
V3 Get Recipients
get
Resource Lock
V3 Contracts
V3 Get List of Resource Locks
get
V3 Get a Resource Lock
get
V3 Lock Resource
post
V3 Unlock Resource
del
V1 Contracts
V1 Get a Resource Lock
get
V1 Get List of Resource Locks
get
V1 Lock Resource
post
V1 Unlock Resource
del
URLA Alternate Names
V3 Contracts
V3 Get URLA Alternate Names
get
V3 Update URLA Version
patch
V3 Update URLA Alternate Names
patch
Verification Input Forms
V3 Contracts
V3 Get VOLs
get
V3 Manage VOLs
patch
V3 Get VODs
get
V3 Manage VODs
patch
V3 Get Non-VOLs
get
V3 Manage non-VoLs
patch
V3 Get Employment
get
V3 Manage Employment
patch
V3 Get Residences
get
V3 Manage Residences
patch
V3 Get Additional Loans
get
V3 Manage Additional Loans
patch
Loan Funding
Manage Funding Fees
V3 Get Funding Fees
get
V3 Update Funding Balances
patch
Manage Funding Balances
V3 Get Funding Balances
get
Loan: Disclosure Tracking Logs
Disclosure Tracking (2015)
V3 Get a List of Disclosure Tracking Logs
get
V3 Add a Disclosure Tracking Log
post
V3 Get a Disclosure Tracking Log
get
V3 Get Disclosure Tracking Log Email Messages
get
V3 Get Disclosure Tracking Snapshots
get
V3 Get Disclosure Tracking Snapshot
get
V3 Update a Disclosure Tracking Log
patch
V3 Add Manual Fulfillment
post
V1 Get a List of Disclosure Tracking Logs
get
V1 Get a Disclosure Tracking Log
get
V1 Get Snapshot
get
Loan: Loan Metadata
Loan Metadata
V1 Get Loan Metadata
get
Loan: Loan Tracking Logs
AUS Tracking
V1 Get All AUS Tracking Logs
get
V1 Create an AUS Tracking Log
post
V1 Get an AUS Tracking Log
get
V1 Update an AUS Tracking Log
patch
V1 Get AUS Tracking Log Snapshot
get
Conversation Log
V3 Create Conversation Log
patch
V1 Get All Conversation Logs
get
V1 Get a Conversation Log
get
Registration Logs
V3 Get Registration Logs
get
V3 Create Registration Log
post
V3 Get a Registration Log
get
V3 Update Registration Log
patch
Request for Transcript of Tax
Request for Transcript of Tax
Preview: V3 Get Request for Transcript of Tax
get
V3 Update Request for Transcript of Tax
patch
ENCOMPASS SCHEMA
Schema
V3 Contracts
V3 Get Loan Schema
get
V3 Get Field Schema
get
V3 Get Virtual Fields
get
V1 Get Loan Schema
get
V1 Get Field Schema
get
V1 Path Generator
post
V1 Contract Generator
post
Secondary and Trades
Correspondent Trades
Trade Pipeline
Contracts
Get Trade Pipeline of Correspondent Trade
post
Get Field Definitions
get
Trade Management
Create a Correspondent Trade
post
Get Correspondent Trade
get
Update a Correspondent Trade
patch
Get Event History
get
Assign Loans to Correspondent Trade
put
Unassign Loans From a Correspondent Trade
del
Get Notes
get
Create a Note
put
Manage a Note
patch
Get Correspondent Trade Statistics
get
Extend a Correspondent Trade
put
ENCOMPASS PERSONALIZATION
Loan Pipeline Views
Preview: V3 Create Pipeline View
post
Preview: V3 Update Pipeline View
patch
Services: Partner Service Orders
Service Orders
Credit Partners and Supported Products
Retrieve Raw XML Files
AUS Providers and Samples
Freddie Mac Affordable Check API
Freddie Mac Datashare APIs
Order Services
post
Get Service Order Status
get
Services: ICE Product and Pricing Engine (ICE PPE)
Overview
User Management
Get User Mapping
get
Map ICE PPE User
patch
Rates
Get Programs and Rates
post
Get Eligible Rates
post
Select Rate
post
Get Adjustments
post
Guidelines
Get Guideline Details
get
Lookups
Get Agency Approvals
get
Get Bankruptcy
get
Get Buydown Type
get
Get Buydown Contributor Type
get
Get Citizenship
get
Get Client Settings
get
Get Commitment Types
get
Get Counties
get
Get Custom Fields
get
Get Delivery Types
get
Get Documentation Types
get
Get Encompass Elements
get
Get Foreclosure
get
Get Investors
get
Get Lien Position
get
Get Loan Terms
get
Get Loan Usage
get
Get Loan Limits
get
Get Locations
get
Get Lock Days
get
NOD Types
get
Get Non QM Doc Level
get
Get Prepay Penalty Terms
get
Get Product Options
get
Get Property Types
get
Get Property Use
get
Get Special Products
get
Get Standard Products
get
Get States
get
Get Unit Types
get
Services: Encompass Compliance Service
Encompass Compliance Service
Create Compliance Report
post
Get Compliance Report
get
Settings: Loan Setup
Disclosure Tracking Settings
V3 Get Disclosure Tracking Settings
get
HMDA Profiles
V3 Get List of HMDA Profiles
get
V3 Get HMDA Profile Details
get
Enhanced Conditions Settings
V3 Get All Enhanced Condition Types
get
V3 Manage Enhanced Condition Types
patch
V3 Get an Enhanced Condition Type
get
V3 Get All Enhanced Condition Sets
get
V3 Get an Enhanced Condition Set
get
V3 Get All Enhanced Condition Templates
get
V3 Manage Enhanced Condition Templates
patch
V3 Get an Enhanced Condition Template
get
V3 Evaluate Automated Conditions
post
Loan Custom Fields
V3 Get Loan Custom Field Settings
get
V3 Manage Custom Fields
patch
V1 Get All Custom Fields
get
V1 Get a Custom Field
get
Loan Folder
V3 Get List of Loan Folders
get
V3 Get a Loan Folder
get
Loan Print Forms
V3 Get List of Print Form Groups
get
V3 Get Print Form Group Details
get
V3 Get List of Standard Print Forms
get
V3 Get List of Custom Print Forms
get
Policies
V3 Get URLA Configuration
get
Settings: SCIM Provisioning & Account Linking
Overview
Manage SCIM Users
Create a User
post
Get Users
get
Get User
get
Update User
patch
Delete User
del
Manage SCIM Groups
Get User Groups
get
Get User Group
get
Update User Group
patch
Manage SCIM Account Links
Create an Account Link
post
Get Linked Accounts
get
Delete an Account Link
del
Link User to Existing GUID
patch
Settings: Tables and Fees
Fee Management
V3 Get Itemization Fee Management
get
V3 Get Loan Originator Compensation Plans
get
Settings and Utilities
Custom Data Objects
V1 Contracts
V1 Get List of Loan CDOs
get
V1 Get a Loan CDO
get
V1 Create or Replace Loan CDO
put
V1 Delete Loan CDO
del
V1 Update Loan CDO
patch
V1 Get List of User CDOs
get
V1 Get a User CDO
get
V1 Create or Replace User CDO
put
V1 Delete User CDO
del
V1 Update User CDO
patch
V1 Get List of Global CDOs
get
V1 Get a Global CDO
get
V1 Create or Replace Global CDO
put
V1 Delete Global CDO
del
V1 Update Global CDO
patch
Settings: Business Contacts
V3 Get Business Contacts Custom Fields
get
V3 Get Business Contacts Categories
get
V3 Get Business Contacts Category Fields
get
Settings: Compliance Reports
Contracts
Manage Compliance Settings Report Permissions
post
Settings: Documents
V3 Get eFolder Document Settings
get
V3 Get eFolder Document Options
get
V3 Get List of eFolder Document Stacking Templates
get
V3 Get eFolder Document Stacking Template Details
get
Settings: External Organizations - Banks
V3 Get External Banks
get
Settings: External Organizations - TPOs
V3 Contracts
V3 Get External Organizations (Slated for Deprecation)
get
V3 Get an External Organization (Slated for Deprecation)
get
V3 Get External Organizations
get
V3 Get External Organization
get
V3 Create External Organization
post
V3 Update External Organization
patch
V3 Manage DBA Records
patch
V3 Manage Warehouse Details
patch
V3 Manage External Organization Site URLs
patch
V3 Get External Organization Commitments
post
Settings: External Organizations - TPO Settings
V3 Get Company Status
get
V3 Get Company Rating
get
V3 Get Company Price Groups
get
V3 Get TPO Custom Field Definitions
get
V3 Get Global TPO Fees
get
V3 Get Global TPO Fee Details
get
V3 Get Global TPO Late Fees
get
Settings: External Users
V3 Contracts
V3 Get All External Users
get
V3 Get an External User
get
V3 Get Effective Rights of External User
get
V3 Manage External Users
patch
Settings: Internal Users
V3 Contracts
V3 Get Eligible Roles
get
V3 Get a List of Internal Users
get
V3 Create Internal User
post
V3 Bulk Update Internal Users
patch
V3 Get Internal User Profile
get
V3 Delete Internal User Profile
del
V3 Update Internal User
patch
V3 Get Internal User Public Profile
get
V3 Update Internal User Public Profile
patch
V3 Manage Internal User Compensation Plans
put
V1 Contracts
V1 Get a List of Users
get
V1 Get a User Profile
get
V1 Get List of User Groups
get
V1 Get Compensation Plans
get
V1 Get License Details
get
V1 Get User's Assigned Rights
get
V1 Get User's Effective Rights
get
Settings: Loan Templates
V3 Contracts
V3 Get Details of a Settlement Service Provider Template File
get
V3 Get List of Loan Program Templates
get
V3 Get Loan Program Template Settings
get
V3 Get Closing Cost Template Settings
get
V3 Get List of Closing Cost Templates
get
V3 Get List of Settlement Service Provider Template Folders
get
V3 Get List of Loan Template Sets
get
V3 Get Transcript of Tax Template
get
V3 Get List of Transcript of Tax Templates
get
V1 Contracts
V1 Get List of Loan Template Sets
get
V1 Get Loan Template Set Settings
get
Settings: Milestones
V3 Get List of Milestones
get
V3 Get Details on Specific Milestone
get
Settings: Organizations
V1 Contracts
V1 Get Root Organization Detail
get
V1 Get All Organizations
get
V1 Get Organization Detail
get
V1 Get Children of Organization
get
Settings: Personas
V3 Contracts
V3 Get a List of Personas
get
V3 Get a Persona
get
V1 Contracts
V1 Get a List of Personas
get
V1 Get a Specific Persona
get
Settings: Roles
V3 Get List of Roles
get
V3 Get Specific Role Details
get
V3 Get Role Mappings
get
V1 Contracts
V1 Get a List of Roles
get
Settings: Secondary
V3 Contracts
V3 Get an Investor Template
get
V3 Get Investor Templates
get
V3 Get Funding Templates
get
Tools: Loan Transformer
Export Loan to MISMO 3.4
get
Tools: Search
Contracts
Search for Field or Form
post
Webhooks: Overview
Overview
Resources and Events
Loan
Document Delivery
Document Order
Enhanced Conditions
Orgs and Users
EPC
Schedulers
Trades
Workflow Tasks
DDA
Retry Logic
Access Controls
Custom Authentication
Signing Keys
Endpoint Requirements
Webhook Event Payload Attributes
Default Payload Attributes
Extra Payload Attributes - Document Delivery
Extra Payload Attributes - DocumentOrder
Extra Payload Attributes - Loan Resources
Extra Payload Attributes - EnhancedConditionTemplate
Extra Payload Attributes - EnhancedConditionType
Extra Payload Attributes - ExternalUsers
Extra Payload Attributes - InternalUsers
Extra Payload Attributes - ServiceOrder
Extra Payload Attributes - SubTask
Extra Payload Attributes - Task
Extra Payload Attributes - TaskComment
Extra Payload Attributes - TaskGroup
Extra Payload Attributes - Timer
Extra Payload Attributes - Trade
Extra Payload Attributes - UserGroup
Webhooks: Resources & Subscriptions
Resources
Get All Resources
get
Get a Resource
get
Get Resource Events
get
Subscriptions
Get All Subscriptions
get
Create a Subscription
post
Update Subscription
put
Get a Subscription
get
Delete Subscription
del
Webhooks: Event History
Event History
Get All Events
get
Get an Event
get
Webhook Custom Auth Configuration
Overview
Create Webhook Custom Auth Function
Create Webhook Custom Auth Function
post
Get Webhook Custom Auth Function List
get
Manage Webhook Custom Auth
Update Webhook Custom Auth Function
put
Delete Webhook Custom Auth Function
del
Update Webhook Custom Auth Credentials
patch
Manage Custom Auth Linking to Webhook Subscription
Link Custom Auth Function to Webhook Subscription
patch
Remove Custom Auth Function from Webhook Subscription
del
Get Custom Auth Functions for Webhook Subscription
get
Test Webhook Custom Auth
Test Webhook Custom Auth Parameters
post
Workflow Management
Overview
Task Configuration
Contracts
Get All Templates
get
Get a Template
get
Update Templates
patch
Update a Template
patch
Create a Template
post
Delete a Template
del
Get Subtask Templates
get
Get a Subtask Template
get
Create a Subtask Template
post
Update a Subtask Template
patch
Delete a Subtask Template
del
Get Task Settings
get
Update Task Settings
put
Task Instance Management
Contracts
Assign All Tasks Based on Role Assignment
patch
Get All Tasks
get
Get a Task
get
Create a Task
post
Delete a Task
del
Update All Tasks
patch
Update a Task
patch
Tasks Bulk Update
patch
Get Comments for a Task
get
Add a Comment to a Task
post
Get All Subtasks
get
Get a Subtask
get
Create a Subtask
post
Update a Subtask
patch
Delete a Subtask
del
Get Comments for a Subtask
get
Add a Comment to a Subtask
post
Get Task Pipeline
get
Powered by
Policies
This section can be used to retrieve Instance Level Policy Settings.
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use