Encompass

Encompass is the dominant mortgage loan origination system (LOS), a product of ICE Mortgage Technology (formerly Ellie Mae, acquired by Intercontinental Exchange / ICE in 2020). Its developer program, Encompass Developer Connect, exposes REST APIs that let partners and lenders configure, customize, and administer loan information and resources programmatically - loan manufacturing, loan pipeline, borrower pairs, contacts, eFolder documents and attachments, milestones, conditions, users, product and pricing, and event webhooks. Access is partner/tenant-gated (OAuth 2.0 credentials issued per Encompass instance by a super administrator), but the API reference is publicly documented at developer.icemortgagetechnology.com.

9 APIs 0 Features
MortgageLoan OriginationLOSFintechICE Mortgage TechnologyEllie MaeLending

APIs

Encompass Loan Management API

Create, read, update, and delete Encompass loan files and read/write the values of loan data fields between applications and Encompass. Includes moving loans between folders and...

Encompass Loan Pipeline API

Search for loans and loan fields across the Encompass pipeline using canonical field names, filter criteria, and cursor-based pagination for large result sets. Retrieve the list...

Encompass Borrower Pair & Applications API

Manage borrower pairs (applications) within a loan file - list, create, read, update, and remove the borrower/co-borrower application entities that carry each borrower's data on...

Encompass Contacts API

Manage borrower (consumer) contacts and business (service provider / vendor) contacts, including contact notes and groupings, in the Encompass contact database.

Encompass eFolder Documents & Attachments API

Manage documents, attachments, and comments in a loan's eFolder - list and create documents, upload and retrieve attachments (via cloud-storage URLs), and manage the placeholder...

Encompass Milestones & Associates API

Read and manage the milestones that mark a loan's progress through the origination workflow, complete/finish milestones, and assign the associates (loan team members) responsibl...

Encompass Conditions API

Track and manage underwriting, preliminary, and post-closing conditions on a loan, including the modern Enhanced Conditions system - list, create, update, and clear conditions a...

Encompass Users API

Manage the internal Encompass users of a lender's instance - list, read, create, and update user accounts, personas, roles, and license/organization assignments that determine w...

Encompass Webhooks API

Subscribe to Encompass resource events (loan created / updated / deleted / locked / unlocked and more), manage subscriptions, browse available resources and their events, query ...

Collections

Encompass Developer Connect API

OPEN

Pricing Plans

Encompass Plans Pricing

2 plans

PLANS

Rate Limits

Encompass Rate Limits

4 limits

RATE LIMITS

FinOps

Encompass Finops

FINOPS

Resources

🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
🔑
OAuthScopes
OAuthScopes
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Encompass Developer Connect API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{accessToken}}'
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Get access token.
      type: http
    http:
      method: POST
      url: https://api.elliemae.com/oauth2/v1/token
      body:
        type: form
        data: grant_type=client_credentials&client_id=&client_secret=&scope=
    docs: Exchange client credentials for a bearer access token scoped to an Encompass instance.
- info:
    name: Loan Management
    type: folder
  items:
  - info:
      name: Create a loan.
      type: http
    http:
      method: POST
      url: https://api.elliemae.com/encompass/v3/loans
      body:
        type: json
        data: '{}'
    docs: Create a new Encompass loan file.
  - info:
      name: Retrieve a loan.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v3/loans/:loanId
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: Retrieve a loan file and its data by loan GUID.
  - info:
      name: Update a loan.
      type: http
    http:
      method: PATCH
      url: https://api.elliemae.com/encompass/v3/loans/:loanId
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
      body:
        type: json
        data: '{}'
    docs: Write values to loan data fields.
  - info:
      name: Delete a loan.
      type: http
    http:
      method: DELETE
      url: https://api.elliemae.com/encompass/v3/loans/:loanId
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: Delete a loan file.
  - info:
      name: Move loan to folder.
      type: http
    http:
      method: PATCH
      url: https://api.elliemae.com/encompass/v1/loans/:loanId/moveToFolder
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
      body:
        type: json
        data: '{ "loanFolder": "" }'
    docs: Move a loan file into a different loan folder.
- info:
    name: Loan Pipeline
    type: folder
  items:
  - info:
      name: Query the pipeline.
      type: http
    http:
      method: POST
      url: https://api.elliemae.com/encompass/v3/loanPipeline
      body:
        type: json
        data: "{\n  \"filter\": { \"canonicalName\": \"Loan.LoanFolder\", \"matchType\": \"exact\", \"value\": \"My Pipeline\"\
          \ },\n  \"fields\": [\"Loan.GUID\", \"Loan.LoanNumber\"]\n}"
    docs: Search for loans and loan fields on the pipeline with filter criteria.
  - info:
      name: Create pipeline cursor.
      type: http
    http:
      method: POST
      url: https://api.elliemae.com/encompass/v3/loanPipeline/cursor
      body:
        type: json
        data: '{}'
    docs: Create a cursor to page through a large pipeline report.
  - info:
      name: Get canonical names.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v3/loanPipeline/canonicalNames
    docs: Retrieve the list of canonical (queryable) field names.
- info:
    name: eFolder
    type: folder
  items:
  - info:
      name: List documents.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v3/loans/:loanId/documents
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: List the documents (placeholders) in a loan's eFolder.
  - info:
      name: List attachments.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v3/loans/:loanId/attachments
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: List the attachments in a loan's eFolder (v3 returns cloud-storage URLs).
- info:
    name: Milestones
    type: folder
  items:
  - info:
      name: List milestones.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v3/loans/:loanId/milestones
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: List the milestones marking a loan's progress (modeled endpoint).
  - info:
      name: List associates.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v3/loans/:loanId/associates
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: List the associates assigned to a loan's milestones (modeled endpoint).
- info:
    name: Conditions
    type: folder
  items:
  - info:
      name: List underwriting conditions.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v1/loans/:loanId/conditions/underwriting
      params:
      - name: loanId
        value: ''
        type: path
        description: The loan GUID.
    docs: List the underwriting conditions tracked on a loan (modeled endpoint).
- info:
    name: Contacts
    type: folder
  items:
  - info:
      name: List borrower contacts.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v1/borrowerContacts
    docs: List consumer (borrower) contacts (modeled endpoint).
  - info:
      name: List business contacts.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v1/businessContacts
    docs: List business (service provider / vendor) contacts (modeled endpoint).
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List users.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v1/users
    docs: List the internal Encompass users of the instance (modeled endpoint).
  - info:
      name: Retrieve a user.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/encompass/v1/users/:userId
      params:
      - name: userId
        value: ''
        type: path
        description: The Encompass user identifier.
    docs: Retrieve an Encompass user by ID (modeled endpoint).
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List subscriptions.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/webhook/v1/subscriptions
    docs: List all webhook subscriptions for the instance.
  - info:
      name: Create a subscription.
      type: http
    http:
      method: POST
      url: https://api.elliemae.com/webhook/v1/subscriptions
      body:
        type: json
        data: "{\n  \"resource\": \"Loan\",\n  \"events\": [\"created\", \"updated\"],\n  \"endpoint\": \"https://example.com/webhook\"\
          \n}"
    docs: Subscribe to resource events delivered to an HTTPS endpoint.
  - info:
      name: Get a subscription.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/webhook/v1/subscriptions/:id
      params:
      - name: id
        value: ''
        type: path
        description: The subscription identifier.
    docs: Retrieve a webhook subscription by ID.
  - info:
      name: Delete a subscription.
      type: http
    http:
      method: DELETE
      url: https://api.elliemae.com/webhook/v1/subscriptions/:id
      params:
      - name: id
        value: ''
        type: path
        description: The subscription identifier.
    docs: Delete a webhook subscription.
  - info:
      name: List resources.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/webhook/v1/resources
    docs: List the resource types available for webhook subscriptions.
  - info:
      name: List events.
      type: http
    http:
      method: GET
      url: https://api.elliemae.com/webhook/v1/events
    docs: Query the history of webhook events delivered to your subscriptions.
bundled: true