Locking a Loan with LOS
This guide covers the full lock lifecycle when you are using a Loan Origination System (LOS) such as Encompass (Ellie Mae). Instead of creating loans directly in the Lender Price system, you pull loan data from Encompass, price it through the API, and lock the selected rate.
Locking Policy
The locking policy is the lock schema that is determined by the lender company of the loan. The locking policy is the flow of locking procedures. It determines allowable locking terms, the procedural flow of lock steps, allowable edits to the lock, and other related factors. It is not determined by Lender Price.
Depending on the lender's locking policy, when a user locks a loan, they might lock the loan automatically, or send a lock request that must be approved by the lender before the lock is complete. The Lender Price API allows companies to create their own locking workflow.
Workflow Overview
Post-lock operations include: Lock Request, Approve/Deny, Reprice, Extension, Post-Lock Price Concession, Cancel Lock, and more.
Lock Status Flow
Guide Pages
This workflow is split across the following pages:
- Price and Create Quote -- Pull a loan from Encompass, search for pricing, and create a price quote.
- Export Pricing and Lock -- Lock a price quote with scenario, retrieve next lock statuses, and add lock events.
- Post-Lock Operations -- Lock requests, approve/deny, reprice, extension, price concession, cancel, and more.
Key Endpoints
| Operation | Endpoint | Method |
|---|---|---|
| Pull Loan Pipeline | /rest/v1/integration/ellie/loan/pipeline | POST |
| Get Loan | /rest/v1/integration/ellie/loan/pipeline/getLoan/{loanId} | GET |
| Get Pricing | /rest/v1/lp-ppe-api/pricing/search?userIdToUse={userId} | POST |
| Create Price Quote | /rest/v1/pipeline | POST |
| Lock with Scenario | /rest/v1/lock/lockWithScenario | POST |
| Export Pricing | /rest/v1/lp-ppe-api/price-quote/setScenarioFromResult/EllieMaeQuoteRequest | POST |
| Get Next Lock Status | /rest/v1/lock/getNextLockStatus/{lockId}/{lockEventId} | GET |
| Add Lock Event | /rest/v1/lp-ppe-api/price-quote/addLockEvent | POST |
| Check Desk Hours | /rest/v1/lp-ppe-api/checkLockStatus/{lockId}/{statusId} | GET |
| Check Rate Period | /rest/v1/lp-ppe-api/isRatePeriodStillActive/{priceQuoteId}/{statusId} | GET |
| Get Estimated Expiration | /rest/v1/lp-ppe-api/getEstimatedExpirationDate/{priceQuoteId}/{days} | GET |
| Get Pricer Config | /rest/lp-config/pricing-config/loanPricer | GET |
| Get Search (for Reprice) | /rest/integration/ellie/getSearch/{priceQuoteId} | GET |
| Reprice Export | /rest/v1/lp-ppe-api/price-quote/setScenarioFromResult/EllieMaeBuyRequest | POST |
Authentication
Most endpoints use secret and companyid headers for authentication. Some pricing endpoints use Authorization: Bearer {{accessToken}} header instead. See each step for the specific headers required.