Model MatchHelp

Companies

Retained borrowers likely to list their home (weekly)

getapi.modelmatch.com/v1/companies/{nmlsId}/retention/likely-to-sell

The company's retained borrowers (their latest loan is still the company's) whose home looks likely to be listed for sale soon, each with the company loan officer who wrote that loan — only LOs the company employed on the loan, not brokers' LOs on loans it only funded. Each row carries a likely-to-list score from 0 to 100: a priority / likelihood ranking, not a probability. Highest score first; filter to one LO with originator. "Likely to list" is the LO Borrower Retention tab's rule: a score of 90 or more, and not listed for sale or under contract now (those are in active-listings). Checked weekly with the retention snapshot — computedAt says when. 404 means not computed for this company yet.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

viewenum

company (default): loans written at the company. team: the company's CURRENT loan officers' borrowers — loans they wrote at the company or at a previous employer (writtenAt), e.g. a recruit's book.

Options:companyteam
originatorstring

Only rows whose loan was written by this LO (NMLS id) — e.g. one of likelyToSell.topOriginators.

sizeinteger

Page size (1-100, default 25).

cursorstring

Opaque cursor from the previous page's cursor.

Responses

200objectOne page of likely-to-list rows
Show attributes
companyNmlsIdstringrequired
computedAtstringrequired

When the weekly batch checked these borrowers (ISO-8601). Rows are as of this time, not live.

cursorstring

Cursor for the next page; absent on the last page.

dataobject[]required
Show child attributes
addressstringrequired

From the company's loan record on the parcel.

lenderstring | nullrequired

Current lender of record: the lender on that loan, which is still the borrower's latest (retained).

loanAmountnumberrequired

Original amount of that loan.

loanDatestringrequired

Date of the company's latest loan on the parcel.

originatorNamestringrequired
originatorNmlsIdstringrequired

The LO who wrote the company's latest loan on the parcel — employed by the company on that loan.

propensityCategorystring | nullrequired

The score's band label (e.g. High).

propertyIdstringrequired
salePropensitynumberrequired

Likely-to-list score, 0–100: a priority / likelihood ranking (higher = more likely to list soon), not a probability. Every row is 90 or more.

writtenAtstring | null

view=team only: the previous employer the LO wrote this loan at. Null on a loan written at the company (and on every view=company row).

statusenumrequired

timeout: the check did not finish in this run, so the previous run's rows and counts are kept (or none, on a first run).

Options:oktimeout
totalintegerrequired

Rows matching the filter, across all pages.

400objectValidation error
401objectUnauthorized
403objectForbidden (authenticated, but missing required context — e.g. no active organization)
404objectNot found
413objectResponse payload too large — detail endpoint capped to fit Lambda response limits
503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.