Jump to Content
Encompass Developer ConnectDownload Postman Collection
GuidesAPI ReferenceRelease Notes
Download Postman CollectionLog InEncompass Developer Connect
API Reference
Log In
GuidesAPI ReferenceRelease Notes

API Reference

  • Welcome
  • API Previews

Consumer Engagement

  • Loan Opportunity Settings
    • Contracts
    • Affordability
      • Get Affordability Qualification Settingsget
      • Create Affordability Qualification Settingspost
      • Update Affordability Qualification Settingsput
      • Delete an Affordability Qualificationdelete
    • Email Template Management
      • Get Email Templateget
      • Create Email Templatepost
      • Get Email Template Detailsget
      • Update Email Templateput
      • Delete an Email Templatedelete
    • Feature Management
      • Get Feature Management Settingsget
      • Create New Featurepost
      • Update a Feature Management Settingpatch
      • Update a Featureput
      • Delete a Feature Management Settingdelete
    • Letter Template Management
      • Get List of Letter Templatesget
      • Get Letter Template Detailsget
      • Create a Letter Templatepost
      • Update Letter Templateput
      • Delete Letter Templatedelete
  • Loan Opportunity Management
    • Contracts
    • Get All Scenariosget
    • Get a Scenarioget
    • Create a Scenariopost
    • Update a Scenarioput
    • Updates a Scenariopatch
    • Delete a Scenariodelete
    • Convert Scenario to Loanget
    • Send a Notification Requestpost
    • Get a Loan Opportunityget
    • Get Loan Opportunitiesget
    • Create Loan Opportunitypost
    • Update Loan Opportunitypatch
    • Replace Loan Opportunityput
    • Delete Loan Opportunitydelete
    • Convert Loan Opportunitypost
  • Document Management for an Opportunity
    • Contracts
    • Get a Documentget
    • Create a Documentpost
    • Update a Documentpatch
  • Loan Opportunity Selector
    • Get Loan Opportunities with Searchget
  • Prospect Engagement
    • Contracts
    • Create Invitation URLpost
    • Create Reminder URLpost

DOCUMENT DELIVERY

  • Packages
    • Get Packagesget
    • Get Packageget
  • Point of Sale Integration Framework
    • Contracts
    • Create a Package Eventpost
    • Create a Sessionpost

Encompass Contacts

  • Borrower
    • V1 Contracts
    • Link Borrower Contacts to a Loan
    • V1 Get Borrower Contact Listpost
    • V1 Get a Borrower Contactget
    • V1 Get Canonical Namesget
    • V1 View Borrower Contacts (with Pagination)post
    • V1 Create Borrower Contactpost
    • V1 Update Borrower Contactpatch
    • V1 Delete Borrower Contactdelete
    • V1 Get All Notes for a Borrower Contactget
    • V1 Get a Note for a Borrower Contactget
    • V1 Create a Note for a Borrower Contactpost
    • V1 Update a Note for a Borrower Contactpatch
    • V1 Delete a Note for a Borrower Contactdelete
  • Groups
    • V1 Contracts
    • V1 Get All Contact Groupsget
    • V1 Get a Contact Groupget
    • V1 Get All Contacts in Contact Groupget
    • V1 Create Contact Grouppost
    • V1 Add or Remove Group Contactspatch
    • V1 Update a Contact Grouppatch
    • V1 Delete a Contact Groupdelete
  • Business
    • V1 Contracts
    • Link Business Contacts to a Loan
    • V1 Get Business Contact Listpost
    • V1 Get a Business Contactget
    • V1 Get Canonical Namesget
    • V1 View Business Contacts (with Pagination)post
    • V1 Create a Business Contactpost
    • V1 Update a Business Contactpatch
    • V1 Delete a Business Contactdelete
    • V1 Get a Note for a Business Contactget
    • V1 Create Note for a Business Contactpost
    • V1 Update Note for a Business Contactpatch
    • V1 Delete Note for a Business Contactdelete

Encompass Docs

  • Send Encompass Docs
    • Contracts
    • Manage Plan Codes
      • Apply Plan Codepost
      • Get Plan Codesget
    • Audit Loan File
      • Create Loan Audit for Opening Orderpost
      • Create Loan Audit for Closing Orderpost
      • Get Document Audit for Opening Orderget
      • Get Document Audit for Closing Orderget
    • Generate Document Package
      • Generate Opening Doc Setpost
      • Generate Closing Doc Setpost
      • Generate Formspost
      • Get Order Statusget
    • Add Documents to a Package
      • Add to Opening Doc Setpost
      • Get Opening Doc Setget
      • Add to Closing Doc Setpost
      • Get Closing Doc Setget
    • Send Document Package
      • Send Opening Packagepost
      • Send Closing Packagepost
      • Send Formspost
      • Get Opening Package Delivery Detailsget
      • Get Closing Package Delivery Detailsget
      • Get Forms Delivery Detailsget
  • Print On Demand
    • Contracts
    • Generate a Print Orderpost
    • Get a Print Orderget

Encompass Loan

  • Assets
    • V3 Contracts
    • V3 Get Other Incomeget
    • V3 Manage Other Incomespatch
    • V3 Get Other Assetsget
    • V3 Manage Other Assetspatch
    • V3 Get Gifts and Grantsget
    • V3 Manage Gifts and Grantspatch
    • V3 Get REO Propertiesget
    • V3 Manage REO Propertiespatch
  • Associates & Milestones
    • V3 Contracts
    • V3 Get Milestone Logs Listget
    • V3 Get Milestone Logget
    • V3 Update Milestone Logpatch
    • V3 Get Milestone Free Role Listget
    • V3 Update Milestone Free Rolepatch
    • V3 Update Milestone Datespatch
    • V1 Contracts
    • V1 Get List of Associatesget
    • V1 Assign a Loan Associateput
    • V1 Get All Milestonesget
    • V1 Get All Milestone Free Rolesget
    • V1 Get an Associateget
    • V1 Get a Milestoneget
    • V1 Update a Milestonepatch
    • V1 Get a Milestone Free Roleget
    • V1 Update a Milestone-Free Rolepatch
  • AUS Tracking
    • V1 Contracts
    • V1 Get All AUS Tracking Logget
    • V1 Get an AUS Tracking Logget
    • V1 Get AUS Tracking Log Snapshotget
    • V1 Create an AUS Tracking Logpost
    • V1 Update an AUS Tracking Logpatch
  • Audit Trail
    • V3 Pull Loan Field Audit Datapost
  • Borrower Pair
    • V1 Contracts
    • V1 Get All Borrower Pairsget
    • V1 Get a Borrower Pairget
    • V1 Create Borrower Pairpost
    • V1 Update Borrower Pairpatch
    • V1 Delete Borrower Pairdelete
    • V1 Move Borrower Pairpatch
  • Borrower Vesting
    • V3 Contracts
    • V3 View Vesting Entitiesget
    • V3 Manage Vesting Entitiespatch
  • Batch Update
    • V1 Get Statusget
    • V1 Update Loanspost
  • Calculators
    • Loan Calculations
      • V1 Contracts
      • V1 Calculate Loanpost
    • Print Form Calculators
      • V3 Contracts
      • V3 Get List of Standard Print Forms for a Loanpost
    • Compliance Calculator
      • V3 Contracts
      • V3 Compliance Calendar Date Calculatorpost
  • Conversation Log
    • V3 Contracts
    • V3 Create Conversation Logpatch
    • V1 Contracts
    • V1 Get All Conversation Logsget
    • V1 Get a Conversation Logget
  • Disasters Collection
    • V3 Contracts
    • V3 Get Disastersget
    • V3 Manage Disasterspatch
  • Disclosure Tracking (2015)
    • V3 Contracts
    • V3 Get a List of Disclosure Tracking Logsget
    • V3 Get a Disclosure Tracking Logget
    • V3 Get Disclosure Tracking Log Email Messagesget
    • V3 Get Disclosure Tracking Snapshotsget
    • V3 Get Disclosure Tracking Snapshotget
    • V3 Add a Disclosure Tracking Logpost
    • V3 Update a Disclosure Tracking Logpatch
    • V3 Add Manual Fulfillmentpost
    • V1 Contract
    • V1 Get a List of Disclosure Tracking Logsget
    • V1 Get a Disclosure Tracking Logget
    • V1 Get Snapshotget
  • eFolder Documents
    • V3 Contracts
    • V3 Get List of Documentsget
    • V3 Get a Documentget
    • V3 Manage Documentspatch
    • V3 Assign Document Attachmentspatch
    • V3 Add Comments to a Documentpatch
    • V1 Contract
    • V1 Get List of Documentsget
    • V1 Get a Documentget
    • V1 Get Document Attachmentsget
    • V1 Create Documentpost
    • V1 Update Documentpatch
    • V1 Assign Document Attachmentspatch
  • eFolder Attachments
    • V3 Contracts
    • V3 Get List of Attachmentsget
    • V3 Get an Attachmentget
    • V3 Update or Remove Attachmentspatch
    • V3 Create Attachment URLpost
    • V3 Get Download Attachment URLpost
    • V1 Contracts
    • V1 Get List of Attachmentsget
    • V1 Get an Attachmentget
    • V1 Get Attachment Metadataget
    • V1 Upload Attachment to eFolderput
    • V1 Get Attachment from eFolderpost
    • V1 Get Thumbnail of Pagepost
    • V1 Get Page of Attachmentpost
    • V1 Update Attachmentpatch
  • eFolder Export Attachments
    • Contracts
    • Get Export Statusget
    • Export Attachmentspost
    • Export Files Job Creatorpost
  • eFolder History
    • V3 Get eFolder Historyget
  • Import from File
    • V3 Converter to Import New Loanpost
    • V3 Importer to Update Loanpost
    • V1 Loan Importer to Create Loanpost
  • Liabilities
    • V3 Contracts
    • V3 Get Other Liabilitiesget
    • V3 Manage Other Liabilitiespatch
  • Loan Contacts
    • V3 Contracts
    • V3 Get Affiliated Business Arrangementsget
    • V3 Manage Affiliated Business Arrangementspatch
    • V3 Manage Service Provider Contacts Listpatch
    • V3 Get Service Provider Contactsget
    • V3 Get Home Counseling Providerget
    • V3 Manage Home Counseling Providers Listpatch
  • Loan Conditions
    • V1 Contracts
    • V1 Get an Underwriting Conditionget
    • V1 Get All Underwriting Conditionsget
    • V1 Create Underwriting Conditionspost
    • V1 Manage Underwriting Conditionspatch
    • V1 Manage Underwriting Commentspatch
    • V1 Manage Underwriting Documentspatch
    • V1 Get All Preliminary Conditionsget
    • V1 Get a Preliminary Conditionget
    • V1 Create Preliminary Conditionspost
    • V1 Manage Preliminary Conditionspatch
    • V1 Manage Preliminary Commentspatch
    • V1 Manage Preliminary Documentspatch
    • V1 Get All Post-Closing Conditionsget
    • V1 Get a Post-Closing Conditionget
    • V1 Create Post-Closing Conditionspost
    • V1 Manage Post-Closing Conditionspatch
    • V1 Manage Post-Closing Commentspatch
    • V1 Manage Post-Closing Documentspatch
  • Loan Enhanced Conditions
    • V3 Contracts
    • V3 Get All Enhanced Conditionsget
    • V3 Get an Enhanced Conditionget
    • V3 Manage Enhanced Conditionspatch
    • V3 Get Commentsget
    • V3 Manage Commentspatch
    • V3 Get Documentsget
    • V3 Manage Documentspatch
    • V3 Get Tracking Entriesget
    • V3 Manage Tracking Entriespatch
    • V3 Evaluate Automated Conditionspost
  • Loan Folder
    • V3 Contracts
    • V3 Get List of Loan Foldersget
    • V3 Get a Loan Folderget
  • Loan Management
    • V3 Get Loanget
    • V3 Create Loanpost
    • V3 Update Loanpatch
    • V3 Delete Loandelete
    • V3 Get UCD Fieldsget
    • V1 Get Loanget
    • V1 Get Loan Metadataget
    • V1 Get Supported Entitiesget
    • V1 Create Loanpost
    • V1 Move Loan to Folderpatch
    • V1 Delete Loandelete
    • V1 Update Loanpatch
  • Loan Management (Reader / Writer)
    • V3 Contracts
    • V3 Field Readerpost
    • V3 Field Writerpost
    • V3 Update Field Lock Datapatch
    • V1 Contracts
    • V1 Field Readerpost
  • Loan Pipeline
    • V3 Contracts
    • V3 Loan Pipeline for Reportspost
    • V3 Loan Pipeline (with Pagination)post
    • V3 Get Canonical Namesget
    • V1 Contracts
    • V1 Get Canonical Namesget
    • V1 Create Cursorpost
    • V1 Loan Pipeline (with Pagination)post
    • V1 Loan Pipelinepost
  • Non-Borrowing Owners
    • V3 Contracts
    • V3 Get Non-Borrowing Ownersget
    • V3 Manage Non-Borrowing Ownerspatch
  • Rate Lock
    • V1 Contracts
    • V1 Get All Rate Lock Requestsget
    • V1 Get a Rate Lock Requestget
    • V1 Get Snapshot of a Rate Lock Requestget
    • V1 Submit a Rate Lock Requestpost
    • V1 Update a Rate Lock Requestpatch
    • V1 Confirm a Rate Lock Requestput
    • V1 Cancel Lock Requestput
    • V1 Deny a Rate Lock Requestput
    • V1 Void a Rate Lock Requestput
  • Recipients
    • V3 Contracts
    • V3 Get Recipientsget
  • Registration Logs
    • V3 Contracts
    • V3 Get Registration Logsget
    • V3 Get a Registration Logget
    • V3 Create Registration Logpost
    • V3 Update Registration Logpatch
  • Resource Lock
    • V3 Contracts
    • V3 Get List of Resource Locksget
    • V3 Get a Resource Lockget
    • V3 Lock Resourcepost
    • V3 Unlock Resourcedelete
    • V1 Contracts
    • V1 Get a Resource Lockget
    • V1 Get List of Resource Locksget
    • V1 Lock Resourcepost
    • V1 Unlock Resourcedelete
  • URLA Alternate Names
    • V3 Contracts
    • V3 Get URLA Alternate Namesget
    • V3 Update URLA Versionpatch
    • V3 Update URLA Alternate Namespatch
  • Verification Input Forms
    • V3 Contracts
    • V3 Get VOLsget
    • V3 Manage VOLspatch
    • V3 Get VODsget
    • V3 Manage VODspatch
    • V3 Get Non-VOLsget
    • V3 Manage non-VoLspatch
    • V3 Get Employmentget
    • V3 Manage Employmentpatch
    • V3 Get Residencesget
    • V3 Manage Residencespatch
    • V3 Get Additional Loansget
    • V3 Manage Additional Loanspatch

ENCOMPASS SCHEMA

  • Schema
    • V3 Contracts
    • V3 Get Loan Schemaget
    • V3 Get Field Schemaget
    • V3 Get Virtual Fieldsget
    • V1 Get Loan Schemaget
    • V1 Get Field Schemaget
    • V1 Path Generatorpost
    • V1 Contract Generatorpost

ENCOMPASS PERSONALIZATION

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

Secondary and Trades

  • Correspondent Trades
    • Trade Pipeline
    • Contracts
    • Get Trade Pipeline of Correspondent Tradepost
    • Get Field Definitionsget
    • Trade Management
      • Create a Correspondent Tradepost
      • Get Correspondent Tradeget
      • Update a Correspondent Tradepatch
    • <