JUMP TOAPI ReferenceWelcomeAPI PreviewsConsumer EngagementLoan Opportunity SettingsContractsAffordabilityGet Affordability Qualification SettingsgetCreate Affordability Qualification SettingspostUpdate Affordability Qualification SettingsputDelete an Affordability QualificationdeleteEmail Template ManagementGet Email TemplategetCreate Email TemplatepostGet Email Template DetailsgetUpdate Email TemplateputDelete an Email TemplatedeleteFeature ManagementGet Feature Management SettingsgetCreate New FeaturepostUpdate a Feature Management SettingpatchUpdate a FeatureputDelete a Feature Management SettingdeleteLetter Template ManagementGet List of Letter TemplatesgetGet Letter Template DetailsgetCreate a Letter TemplatepostUpdate Letter TemplateputDelete Letter TemplatedeleteLoan Opportunity ManagementContractsGet All ScenariosgetGet a ScenariogetCreate a ScenariopostUpdate a ScenarioputUpdates a ScenariopatchDelete a ScenariodeleteConvert Scenario to LoangetSend a Notification RequestpostGet a Loan OpportunitygetGet Loan OpportunitiesgetCreate Loan OpportunitypostUpdate Loan OpportunitypatchReplace Loan OpportunityputDelete Loan OpportunitydeleteConvert Loan OpportunitypostDocument Management for an OpportunityContractsGet a DocumentgetCreate a DocumentpostUpdate a DocumentpatchLoan Opportunity SelectorGet Loan Opportunities with SearchgetProspect EngagementContractsCreate Invitation URLpostCreate Reminder URLpostDOCUMENT DELIVERYPackagesGet PackagesgetGet PackagegetPoint of Sale Integration FrameworkContractsCreate a Package EventpostCreate a SessionpostEncompass ContactsBorrowerV1 ContractsLink Borrower Contacts to a LoanV1 Get Borrower Contact ListpostV1 Get a Borrower ContactgetV1 Get Canonical NamesgetV1 View Borrower Contacts (with Pagination)postV1 Create Borrower ContactpostV1 Update Borrower ContactpatchV1 Delete Borrower ContactdeleteV1 Get All Notes for a Borrower ContactgetV1 Get a Note for a Borrower ContactgetV1 Create a Note for a Borrower ContactpostV1 Update a Note for a Borrower ContactpatchV1 Delete a Note for a Borrower ContactdeleteGroupsV1 ContractsV1 Get All Contact GroupsgetV1 Get a Contact GroupgetV1 Get All Contacts in Contact GroupgetV1 Create Contact GrouppostV1 Add or Remove Group ContactspatchV1 Update a Contact GrouppatchV1 Delete a Contact GroupdeleteBusinessV1 ContractsLink Business Contacts to a LoanV1 Get Business Contact ListpostV1 Get a Business ContactgetV1 Get Canonical NamesgetV1 View Business Contacts (with Pagination)postV1 Create a Business ContactpostV1 Update a Business ContactpatchV1 Delete a Business ContactdeleteV1 Get a Note for a Business ContactgetV1 Create Note for a Business ContactpostV1 Update Note for a Business ContactpatchV1 Delete Note for a Business ContactdeleteEncompass DocsSend Encompass DocsContractsManage Plan CodesApply Plan CodepostGet Plan CodesgetAudit Loan FileCreate Loan Audit for Opening OrderpostCreate Loan Audit for Closing OrderpostGet Document Audit for Opening OrdergetGet Document Audit for Closing OrdergetGenerate Document PackageGenerate Opening Doc SetpostGenerate Closing Doc SetpostGenerate FormspostGet Order StatusgetAdd Documents to a PackageAdd to Opening Doc SetpostGet Opening Doc SetgetAdd to Closing Doc SetpostGet Closing Doc SetgetSend Document PackageSend Opening PackagepostSend Closing PackagepostSend FormspostGet Opening Package Delivery DetailsgetGet Closing Package Delivery DetailsgetGet Forms Delivery DetailsgetPrint On DemandContractsGenerate a Print OrderpostGet a Print OrdergetEncompass LoanAssetsV3 ContractsV3 Get Other IncomegetV3 Manage Other IncomespatchV3 Get Other AssetsgetV3 Manage Other AssetspatchV3 Get Gifts and GrantsgetV3 Manage Gifts and GrantspatchV3 Get REO PropertiesgetV3 Manage REO PropertiespatchAssociates & MilestonesV3 ContractsV3 Get Milestone Logs ListgetV3 Get Milestone LoggetV3 Update Milestone LogpatchV3 Get Milestone Free Role ListgetV3 Update Milestone Free RolepatchV1 ContractsV1 Get List of AssociatesgetV1 Assign a Loan AssociateputV1 Get All MilestonesgetV1 Get All Milestone Free RolesgetV1 Get an AssociategetV1 Get a MilestonegetV1 Update a MilestonepatchV1 Get a Milestone Free RolegetV1 Update a Milestone-Free RolepatchAUS TrackingV1 ContractsV1 Get All AUS Tracking LoggetV1 Get an AUS Tracking LoggetV1 Get AUS Tracking Log SnapshotgetV1 Create an AUS Tracking LogpostV1 Update an AUS Tracking LogpatchAudit TrailV3 Pull Loan Field Audit DatapostBorrower PairV1 ContractsV1 Get All Borrower PairsgetV1 Get a Borrower PairgetV1 Create Borrower PairpostV1 Update Borrower PairpatchV1 Delete Borrower PairdeleteV1 Move Borrower PairpatchBorrower VestingV3 ContractsV3 View Vesting EntitiesgetV3 Manage Vesting EntitiespatchBatch UpdateV1 Get StatusgetV1 Update LoanspostConversation LogV3 ContractsV3 Create Conversation LogpatchV1 ContractsV1 Get All Conversation LogsgetV1 Get a Conversation LoggetDisasters CollectionV3 ContractsV3 Get DisastersgetV3 Manage DisasterspatchDisclosure Tracking (2015)V3 ContractsV3 Get a List of Disclosure Tracking LogsgetV3 Get a Disclosure Tracking LoggetV3 Get Disclosure Tracking Log Email MessagesgetV3 Get Disclosure Tracking SnapshotsgetV3 Get Disclosure Tracking SnapshotgetV3 Add a Disclosure Tracking LogpostV3 Update a Disclosure Tracking LogpatchV3 Add Manual FulfillmentpostV1 ContractV1 Get a List of Disclosure Tracking LogsgetV1 Get a Disclosure Tracking LoggetV1 Get SnapshotgeteFolder DocumentsV3 ContractsV3 Get List of DocumentsgetV3 Get a DocumentgetV3 Manage DocumentspatchV3 Assign Document AttachmentspatchV3 Add Comments to a DocumentpatchV1 ContractV1 Get List of DocumentsgetV1 Get a DocumentgetV1 Get Document AttachmentsgetV1 Create DocumentpostV1 Update DocumentpatchV1 Assign Document AttachmentspatcheFolder AttachmentsV3 ContractsV3 Get List of AttachmentsgetV3 Get an AttachmentgetV3 Update or Remove AttachmentspatchV3 Create Attachment URLpostV3 Get Download Attachment URLpostV1 ContractsV1 Get List of AttachmentsgetV1 Get an AttachmentgetV1 Get Attachment MetadatagetV1 Upload Attachment to eFolderputV1 Get Attachment from eFolderpostV1 Get Thumbnail of PagepostV1 Get Page of AttachmentpostV1 Update AttachmentpatcheFolder Export AttachmentsContractsGet Export StatusgetExport AttachmentspostExport Files Job CreatorposteFolder HistoryV3 Get eFolder HistorygetImport from FileV3 Converter to Import New LoanpostV3 Importer to Update LoanpostV1 Loan Importer to Create LoanpostLiabilitiesV3 ContractsV3 Get Other LiabilitiesgetV3 Manage Other LiabilitiespatchLoan ContactsV3 ContractsV3 Get Affiliated Business ArrangementsgetV3 Manage Affiliated Business ArrangementspatchV3 Manage Service Provider Contacts ListpatchV3 Get Service Provider ContactsgetV3 Get Home Counseling ProvidergetV3 Manage Home Counseling Providers ListpatchLoan ConditionsV1 ContractsV1 Get an Underwriting ConditiongetV1 Get All Underwriting ConditionsgetV1 Create Underwriting ConditionspostV1 Manage Underwriting ConditionspatchV1 Manage Underwriting CommentspatchV1 Manage Underwriting DocumentspatchV1 Get All Preliminary ConditionsgetV1 Get a Preliminary ConditiongetV1 Create Preliminary ConditionspostV1 Manage Preliminary ConditionspatchV1 Manage Preliminary CommentspatchV1 Manage Preliminary DocumentspatchV1 Get All Post-Closing ConditionsgetV1 Get a Post-Closing ConditiongetV1 Create Post-Closing ConditionspostV1 Manage Post-Closing ConditionspatchV1 Manage Post-Closing CommentspatchV1 Manage Post-Closing DocumentspatchLoan Enhanced ConditionsV3 ContractsV3 Get All Enhanced ConditionsgetV3 Get an Enhanced ConditiongetV3 Manage Enhanced ConditionspatchV3 Get CommentsgetV3 Manage CommentspatchV3 Get DocumentsgetV3 Manage DocumentspatchV3 Get Tracking EntriesgetV3 Manage Tracking EntriespatchV3 Evaluate Automated ConditionspostLoan FolderV3 ContractsV3 Get List of Loan FoldersgetV3 Get a Loan FoldergetLoan ManagementV3 Get LoangetV3 Create LoanpostV3 Update LoanpatchV3 Delete LoandeleteV1 Get LoangetV1 Get Loan MetadatagetV1 Get Supported EntitiesgetV1 Create LoanpostV1 Move Loan to FolderpatchV1 Delete LoandeleteV1 Update LoanpatchLoan Management (Reader / Writer)V3 ContractsV3 Field ReaderpostV3 Field WriterpostV3 Update Field Lock DatapatchV1 ContractsV1 Field ReaderpostLoan PipelineV3 ContractsV3 Loan Pipeline for ReportspostV3 Loan Pipeline (with Pagination)postV3 Get Canonical NamesgetV1 ContractsV1 Get Canonical NamesgetV1 Create CursorpostV1 Loan Pipeline (with Pagination)postV1 Loan PipelinepostNon-Borrowing OwnersV3 ContractsV3 Get Non-Borrowing OwnersgetV3 Manage Non-Borrowing OwnerspatchRate LockV1 ContractsV1 Get All Rate Lock RequestsgetV1 Get a Rate Lock RequestgetV1 Get Snapshot of a Rate Lock RequestgetV1 Submit a Rate Lock RequestpostV1 Update a Rate Lock RequestpatchV1 Confirm a Rate Lock RequestputV1 Cancel Lock RequestputV1 Deny a Rate Lock RequestputV1 Void a Rate Lock RequestputRecipientsV3 ContractsV3 Get RecipientsgetRegistration LogsV3 ContractsV3 Get Registration LogsgetV3 Get a Registration LoggetV3 Create Registration LogpostV3 Update Registration LogpatchResource LockV3 ContractsV3 Get List of Resource LocksgetV3 Get a Resource LockgetV3 Lock ResourcepostV3 Unlock ResourcedeleteV1 ContractsV1 Get a Resource LockgetV1 Get List of Resource LocksgetV1 Lock ResourcepostV1 Unlock ResourcedeleteURLA Alternate NamesV3 ContractsV3 Get URLA Alternate NamesgetV3 Update URLA VersionpatchV3 Update URLA Alternate NamespatchVerification Input FormsV3 ContractsV3 Get VOLsgetV3 Manage VOLspatchV3 Get VODsgetV3 Manage VODspatchV3 Get Non-VOLsgetV3 Manage non-VoLspatchV3 Get EmploymentgetV3 Manage EmploymentpatchV3 Get ResidencesgetV3 Manage ResidencespatchV3 Get Additional LoansgetV3 Manage Additional LoanspatchENCOMPASS SCHEMASchemaV3 ContractsV3 Get Loan SchemagetV3 Get Field SchemagetV3 Get Virtual FieldsgetV1 Get Loan SchemagetV1 Get Field SchemagetV1 Path GeneratorpostV1 Contract GeneratorpostENCOMPASS PERSONALIZATIONLoan Pipeline ViewsPreview: V3 Create Pipeline ViewpostPreview: V3 Update Pipeline ViewpatchSecondary and TradesCorrespondent TradesTrade PipelineContractsGet Trade Pipeline of Correspondent TradepostGet Field DefinitionsgetTrade ManagementCreate a Correspondent TradepostGet Correspondent TradegetUpdate a Correspondent TradepatchGet Event HistorygetAssign Loans to Correspondent TradeputUnassign Loans From a Correspondent TradedeleteGet NotesgetCreate a NoteputManage a NotepatchGet Correspondent Trade StatisticsgetExtend a Correspondent TradeputSecondaryV3 ContractsV3 Get an Investor TemplategetV3 Get Investor TemplatesgetV3 Get Funding TemplatesgetServicesEncompass Compliance ServiceContractsGet a Compliance ReportgetGet Compliance ReportsgetCreate a Compliance ReportpostICE Product and Pricing Engine (ICE PPE)ContractsGet User MappinggetMap ICE PPE UserpatchGet Programs and RatespostGet Eligible RatespostSelect RatepostGet AdjustmentspostGet Guideline DetailsgetGet Agency ApprovalsgetGet BankruptcygetGet Buydown TypegetGet Buydown Contributor TypegetGet CitizenshipgetGet Client SettingsgetGet Commitment TypesgetGet CountiesgetGet Custom FieldsgetGet Delivery TypesgetGet Documentation TypesgetGet Encompass ElementsgetGet ForeclosuregetGet InvestorsgetGet Lien PositiongetGet Loan TermsgetGet Loan UsagegetGet Loan LimitsgetGet LocationsgetGet Lock DaysgetNOD TypesgetGet Non QM Doc LevelgetGet Prepay Penalty TermsgetGet Product OptionsgetGet Property TypesgetGet Property UsegetGet Special ProductsgetGet Standard ProductsgetGet StatesgetGet Unit TypesgetPartner ServicesCredit Partners and SamplesElectronic Verifications Partners and SamplesRetrieve Raw XML FilesAUS Partners and SamplesFreddie Mac Datashare APIsAppraisal Partners and SamplesFlood Partners and SamplesOrder ServicespostGet Service Order StatusgetSettings and UtilitiesCustom Data ObjectsV1 ContractsV1 Get List of Loan CDOsgetV1 Get a Loan CDOgetV1 Create or Replace Loan CDOputV1 Delete Loan CDOdeleteV1 Update Loan CDOpatchV1 Get List of User CDOsgetV1 Get a User CDOgetV1 Create or Replace User CDOputV1 Delete User CDOdeleteV1 Update User CDOpatchV1 Get List of Global CDOsgetV1 Get a Global CDOgetV1 Create or Replace Global CDOputV1 Delete Global CDOdeleteV1 Update Global CDOpatchSettings: Disclosure TrackingV3 ContractsV3 Get Disclosure Tracking SettingsgetSettings: DocumentsV3 Get eFolder Document SettingsgetV3 Get eFolder Document OptionsgetV3 Get List of eFolder Document Stacking TemplatesgetV3 Get eFolder Document Stacking Template DetailsgetSettings: Enhanced ConditionsV3 ContractsV3 Get All Enhanced Condition TypesgetV3 Get An Enhanced Condition TypegetV3 Manage Enhanced Condition TypespatchV3 Get All Enhanced Condition SetsgetV3 Get An Enhanced Condition SetgetV3 Get All Enhanced Condition TemplatesgetV3 Get An Enhanced Condition TemplategetV3 Manage Enhanced Condition TemplatespatchSettings: External Organizations - BanksV3 Get External BanksgetSettings: External Organizations - TPOsV3 ContractsV3 Get External Organizations (Slated for Deprecation)getV3 Get an External Organization (Slated for Deprecation)getV3 Get External OrganizationsgetV3 Get External OrganizationgetV3 Create External OrganizationpostV3 Update External OrganizationpatchV3 Manage DBA RecordspatchV3 Manage Warehouse DetailspatchV3 Get External Organization CommitmentspostSettings: External Organizations - TPO SettingsV3 Get Company StatusgetV3 Get Company RatinggetV3 Get Company Price GroupsgetV3 Get TPO Custom Field DefinitionsgetSettings: External UsersV3 ContractsV3 Get All External UsersgetV3 Get an External UsergetV3 Get Effective Rights of External UsergetV3 Manage External UserspatchSettings: Fee ManagementV3 Get Itemization Fee ManagementgetV3 Get Loan Originator Compensation PlansgetSettings: Loan Custom FieldsV3 ContractsV3 Custom Field FormatsV3 Get Loan Custom Field SettingsgetV3 Manage Custom FieldspatchV1 ContractsV1 Get All Custom FieldsgetV1 Get a Custom FieldgetSettings: Loan TemplatesV3 ContractsV3 Get Details of a Settlement Service Provider Template FilegetV3 Get List of Loan Program TemplatesgetV3 Get Loan Program Template SettingsgetV3 Get Closing Cost Template SettingsgetV3 Get List of Closing Cost TemplatesgetV3 Get List of Settlement Service Provider Template FoldersgetV3 Get List of Loan Template SetsgetV3 Get Transcript of Tax TemplategetV3 Get List of Transcript of Tax TemplatesgetV1 ContractsV1 Get List of Loan Template SetsgetV1 Get Loan Template Set SettingsgetSettings: HMDA ProfilesV3 Get List of HMDA ProfilesgetV3 Get HMDA Profile DetailsgetSettings: OrganizationsV1 ContractsV1 Get Root Organization DetailgetV1 Get All OrganizationsgetV1 Get Organization DetailgetV1 Get Children of OrganizationgetSettings: PersonasV3 ContractsV3 Get a List of PersonasgetV3 Get a PersonagetV1 ContractsV1 Get a List of PersonasgetV1 Get a Specific PersonagetSettings: PoliciesV3 Get URLA ConfigurationgetSettings: RolesV1 ContractsV1 Get a List of RolesgetSettings: Internal UsersV3 ContractsV3 Get Eligible RolesgetV3 Get a List of Internal UsersgetV3 Create Internal UserpostV3 Bulk Update Internal UserspatchV3 Get Internal User ProfilegetV3 Delete Internal User ProfiledeleteV3 Update Internal UserpatchV3 Get Internal User Public ProfilegetV3 Update Internal User Public ProfilepatchV3 Manage Internal User Compensation PlansputV1 ContractsV1 Get a List of UsersgetV1 Get a User ProfilegetV1 Get List of User GroupsgetV1 Get Compensation PlansgetV1 Get License DetailsgetV1 Get User's Assigned RightsgetV1 Get User's Effective RightsgetSettings: SCIM ProvisioningContractsSchemasCreate UserpostGet UsersgetGet UsergetUpdate UserpatchDelete UserdeleteGet User GroupsgetGet User GroupgetUpdate User GrouppatchSettings: SCIM Account LinksContractsGet Linked AccountsgetCreate an Account LinkpostLink User to a SCIM GUIDpatchDelete an Account LinkdeleteTools: Loan TransformerExport Loan to MISMO 3.4getTools: SearchContractsSearch for Field or FormpostTools: Transient CalculatorV1 ContractsV1 Calculate LoanpostWebhookOverviewResources and EventsLoanDocument DeliveryDocument OrderEnhanced ConditionsOrgs and UsersEPCSchedulersTradesWorkflow TasksDDAEndpoint RequirementsSigning KeysCustom AuthorizationAccess ControlsRetry LogicResourcesContractsGet All ResourcesgetGet a ResourcegetGet Resource EventsgetSubscriptionsContractsGet All SubscriptionsgetGet a SubscriptiongetCreate a SubscriptionpostUpdate SubscriptionputDelete SubscriptiondeleteEvent HistoryContractsGet an EventgetGet All EventsgetWorkflow ManagementOverviewTask ConfigurationContractsGet All TemplatesgetGet a TemplategetUpdate TemplatespatchCreate a TemplatepostDelete a TemplatedeleteGet Subtask TemplatesgetGet a Subtask TemplategetCreate a Subtask TemplatepostUpdate a Subtask TemplatepatchDelete a Subtask TemplatedeleteGet Task SettingsgetUpdate Task SettingsputTask Instance ManagementContractsAssign All Tasks Based on Role AssignmentpatchGet All TasksgetGet a TaskgetCreate a TaskpostDelete a TaskdeleteUpdate All TaskspatchUpdate a TaskpatchTasks Bulk UpdatepatchGet Comments for a TaskgetAdd a Comment to a TaskpostGet All SubtasksgetGet a SubtaskgetCreate a SubtaskpostUpdate a SubtaskpatchDelete a SubtaskdeleteGet Comments for a SubtaskgetAdd a Comment to a SubtaskpostGet Task PipelinegetV3 Get a Resource Lockget https://api.elliemae.com/encompass/v3/resourceLocks/{lockId}Retrieves lock information for the specified resource.
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use