Loan Management

Metro 2 Integration for Encompass (ICE)

Integrate with ICE Mortgage Technology's Encompass platform — the dominant mortgage loan origination system in the U.S. — via its Developer Connect REST API (200+ endpoints, OAuth 2.0). Metro2 pulls borrower data, loan terms, payment history, and property information through the Encompass API, generates Metro 2 Base Segments and K3 mortgage segments, and submits to credit bureaus. Encompass supports webhooks for loan events (create, update, milestone changes) and provides a comprehensive Loan Data Dictionary with JSON field paths. Encompass is primarily an origination system and does not generate Metro 2 files natively.

How It Works

Metro2 authenticates to Encompass Developer Connect via OAuth 2.0 (API Key required from super administrator + access token). Loan data is queried through the REST API using JSON field paths from the Loan Data Dictionary. Webhooks notify Metro2 of loan events in real time. Metro2 generates Metro 2 Base Segments and K3 mortgage segments and submits to credit bureaus.

Encompass (ICE)

Metro2

Credit Bureaus

API Integration Details

Technical details about connecting to the Encompass (ICE) API.

Authentication

OAuth 2.0 (API Key from super admin + access tokens; supports User Impersonation and SAML SSO)

Base URL

https://developer.icemortgagetechnology.com/developer-connect

Documentation

View Docs

Sandbox

Available

Pricing

Enterprise pricing — Encompass is the dominant U.S. mortgage LOS. API concurrency limit increases require contacting ICE relationship manager (additional fees apply).

Key API Endpoints

Method	Endpoint	Description
GET	/loans/{id}	Returns full loan data with JSON field paths (e.g., $.applications[0].borrower.firstName).
POST	/loans	Creates a new loan file in the Encompass pipeline.
PATCH	/loans/{id}	Partially updates loan fields using JSON field paths.
POST	/pipeline	Queries the loan pipeline with filter criteria — returns matching loan summaries.
GET	/loans/{id}/borrowerPairs	Returns borrower and co-borrower pairs for a loan.
GET	/contacts	Returns borrower and business contact records.
GET	/v3/schemas/loan	Returns the V3 loan schema with all available fields.
GET	/v3/schemas/loan/fieldDefinitions	Returns field metadata — fieldId, JSON Path, description, and data type.
POST	/webhooks/subscriptions	Creates a webhook subscription for loan, document, or milestone events.
GET	/webhooks/subscriptions/{id}/events	Returns event history for a webhook subscription.

Benefits

200+ REST API Endpoints

Encompass Developer Connect exposes 200+ endpoints across loan CRUD, contacts, documents, pipeline, services, settings, and webhooks — comprehensive access to all mortgage data.

Real-Time Loan Webhooks

Subscribe to loan events (Create, Update, Submit, Milestone, Document) via Encompass webhooks. Payloads include eventId, eventTime, resourceId, and are signed for verification.

Comprehensive Loan Data Dictionary

Encompass provides a Loan Data Dictionary with JSON field paths (e.g., $.applications[0].borrower.firstName) and field metadata via the V3 Get Field Schema API.

K3 Segment Automation

Metro2 generates mortgage-specific K3 segments from Encompass loan and property data — required for all mortgage tradelines.

MISMO 3.4/ULAD Compliance

Encompass is MISMO-certified with ULAD support, ensuring standardized data formats for accurate Metro 2 mapping.

Dominant Market Position

Encompass is the most widely used mortgage LOS in the U.S., making this integration relevant to the majority of mortgage lenders.

Data Fields That Sync

Metro2 maps these fields from Encompass (ICE) to Metro 2 format automatically.

Borrower data via Encompass Contacts API (name, SSN, DOB, address, employment)
Loan details via Loan CRUD endpoints (program, rate, term, LTV, loan amount)
Borrower Pair management for co-borrower reporting
Payment schedule and history from loan records
Property information for K3 segment (address, type, occupancy, units)
Loan conditions and milestones for status tracking
eFolder documents and attachments
Pipeline query results for batch processing (POST /pipeline)
Rate lock request data

Real-Time Webhooks

Encompass (ICE) sends webhook events so Metro2 can react to changes instantly.

Loan Create

Fires when a new loan file is created. Metro2 can begin tracking the loan for future reporting.

Loan Update

Fires when loan fields are modified. Metro2 updates borrower and term data.

Loan Milestone

Fires when a loan reaches a new milestone (e.g., funded, closed). Metro2 can trigger reporting based on milestone.

Loan Submit

Fires when a loan is submitted. Useful for tracking origination pipeline.

Document Delivery

Fires when documents are delivered or ordered for a loan.

Workflow Task

Fires when workflow tasks are created or completed.

Get Set Up in 5 Steps

Obtain Encompass API Key

Only super administrators can generate API keys in Encompass. Obtain an API Key and configure OAuth 2.0 access tokens via the Developer Connect portal.

Configure in Metro2

Enter your Encompass API Key and OAuth credentials. Metro2 will authenticate and verify access to loan data.

Set Up Webhook Subscriptions

Subscribe to Loan events (Create, Update, Milestone) via the Encompass webhook API. Configure signing keys for payload verification.

Map Loan Programs to Metro 2

Configure how Encompass loan programs map to Metro 2 Account Type, Portfolio Type, and K3 segment fields using the Loan Data Dictionary.

Test and Launch

Generate test Metro 2 files with K3 segments. Verify field mappings using V3 Get Loan Schema and Get Field Schema APIs.

Frequently Asked Questions

How does Encompass API authentication work?

Encompass uses OAuth 2.0 with an API Key (only super administrators can generate them) plus access tokens. The platform supports API User authentication for ISV Partners and optional multi-factor authentication.

What are the API rate limits?

Encompass enforces a default of 30 concurrent API calls per lender environment (hard stop). HTTP 429 is returned when exceeded. Response headers include X-Concurrency-Limit-Limit and X-Concurrency-Limit-Remaining. Lenders should stay below 80% utilization; ISV partners below 20%.

Does Encompass generate Metro 2 files natively?

No. Encompass is primarily a mortgage origination system. ICE's MSP servicing platform handles servicing-side credit reporting. This Metro2 integration fills the gap for lenders who need Metro 2 reporting from Encompass data.

What webhook events are available?

Encompass supports webhooks for Loan (Create, Update, Submit, Change, Move, Document, Milestone), Document Delivery, Document Order, Enhanced Conditions, Orgs & Users, Trades, and Workflow Tasks. Payloads are signed for verification.

Which API versions are supported?

Encompass has V1 and V3 APIs. V3 uses the same OAuth token flow but has different data contracts. Metro2 supports both versions with a migration path to V3.

Does this require Encompass Partner Connect?

Partner Connect provides ISV-level API access with dedicated authentication. Metro2 can work with either Partner Connect or direct API access through your lender environment.

Related Integrations

Mortgage Cadence

Loan Management

Pull mortgage origination data from Mortgage Cadence Platform's GraphQL API for Metro 2 credit reporting with K3 segment generation.

Finastra Fusion

Loan Management

Pull loan data from Finastra's FusionFabric.cloud APIs (OAuth 2.0, 200+ endpoints) to generate Metro 2 credit reports.

Nortridge Loan System

Loan Management

Enhance Nortridge's built-in Metro 2 reporting with Metro2's validation engine, or pull loan data via NLS REST API (OAuth 2.0, Swagger/OpenAPI).

Ready to Connect Encompass (ICE)?

Start reporting to credit bureaus from Encompass (ICE) today. Our team will help you get set up quickly.