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

Loan Funding

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

Loan: Loan Metadata

Loan Metadata
- V1 Get Loan Metadataget

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

ENCOMPASS SCHEMA

Schema

Secondary and Trades

Correspondent Trades

ENCOMPASS PERSONALIZATION

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

Services: ICE PPE

ICE Product and Pricing Engine (ICE PPE)

Services: Partner Service Orders

Service Orders

Services: Encompass Compliance Service

Encompass Compliance Service
- Create Compliance Reportpost
- Get Compliance Reportget

Settings: SCIM Provisioning & Account Linking

Overview
Manage SCIM Users
Manage SCIM Groups
Manage SCIM Account Links

Settings: Tables and Fees

Fee Management
- V3 Get Itemization Fee Managementget
- V3 Get Loan Originator Compensation Plansget

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: 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: Secondary
Tools: Loan Transformer
- Export Loan to MISMO 3.4get
Tools: Search
- Contracts
- 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 Management

Overview
Task Configuration
Task Instance Management

Powered by

Loan Metadata

Use this API to retrieve metadata from a loan. Metadata includes basic high-level information with regard to the loan file as covered in this API endpoint.

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