@this-npm-test-org/connection-encompass
v0.1.3
Published
Mortgage loan origination: loans, borrowers, milestones, documents, pricing, and pipeline management.
Readme
Encompass (ICE Mortgage Technology) Connection
Connects your agent to Encompass for loan origination data. Read loan details, milestone status, conditions, documents, rate locks, and borrower information. Write operations (update milestone, clear condition) require confirmation.
Authentication
OAuth2 client credentials flow.
client_id— Encompass API client IDclient_secret— Encompass API client secretinstance_id— Your Encompass instance IDusername— Encompass user (for user-context API calls)password— Encompass password
Endpoints
Loans
POST /encompass/v3/loans/search— Search loans by field criteria (borrower name, status, loan officer)GET /encompass/v3/loans/{loanId}— Get loan detail with all fieldsPATCH /encompass/v3/loans/{loanId}— Update loan fields (requires confirmation)
Milestones
GET /encompass/v3/loans/{loanId}/milestones— Get milestone timeline with dates and statusPATCH /encompass/v3/loans/{loanId}/milestones/{id}— Update milestone (requires confirmation)
Conditions
GET /encompass/v3/loans/{loanId}/conditions— List conditions with status, category, and responsibilityPATCH /encompass/v3/loans/{loanId}/conditions/{id}— Clear or waive condition (requires confirmation)
Documents
GET /encompass/v3/loans/{loanId}/documents— List documents with statusGET /encompass/v3/loans/{loanId}/attachments— List file attachments
Rate Locks
GET /encompass/v3/loans/{loanId}/ratelocks— Get rate lock history and current lockPOST /encompass/v3/loans/{loanId}/ratelocks— Request rate lock (requires confirmation)
Pipeline
POST /encompass/v3/loanPipeline— Get pipeline view with custom filters and fields
Rules
- Rate limit: 40 requests/second (Encompass standard)
- Condition clearing and milestone updates always require confirmation
- Rate lock requests require confirmation with rate, term, and lock period
- The agent formats loan amounts as currency and dates as MM/DD/YYYY
- PII fields (SSN, DOB) are never included in agent responses — masked by default
