Model MatchHelp

Companies

Loans one LO captured from this company

getapi.modelmatch.com/v1/companies/{nmlsId}/retention/captured

The loss rows (the LO report's churnedLoans shape) one capturing loan officer took from the company's borrowers in a stored snapshot's period, newest first, paged. Read live from that LO's parcels, so total matches the snapshot's count for the LO (give or take loans recorded since computedAt). 404 when the snapshot has not been computed.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

windowenumdefault: "last12Months"

The snapshot window whose period to use: last12Months (default) or allTime.

Options:last12MonthsallTime
capturingLoNmlsIdstringrequired

The capturing loan officer (a snapshot capturingOriginators[].nmlsId).

kindenum

Only refinances or only second liens. Default both.

Options:refisecond
limitinteger

Rows per page (default 100, at most 500).

offsetinteger | null

Rows to skip (newest first).

Responses

200objectThe capturer's loss rows
Show attributes
countsobjectrequired

The capturer's rows by kind, ignoring kind.

Show child attributes
refinumberrequired
secondnumberrequired
rowsobject[]required
Show child attributes
addressstringrequired
borrowerstringrequired
capturingAmountnumberrequired
capturingCompanystringrequired
capturingCompanyNmlsIdstringrequired
capturingLenderstringrequired
capturingLoNamestringrequired
capturingLoNmlsIdstringrequired
capturingLoanTypestringrequired
capturingRatenumber | nullrequired
cashOutbooleanrequired
currentobject | nullrequired

What the parcel looks like today, when a scored snapshot newer than the event joined; null otherwise (unknown, never 'retained').

Show child attributes
currentBalancenumber | nullrequired
currentLenderstring | nullrequired
currentRatenumber | nullrequired
lastSaleDatenumber | nullrequired
loStillActivebooleanrequired
ownerChangedboolean | nullrequired
daysToEventnumberrequired
eventDatenumberrequired
kindenumrequired
Options:refisecond
laneenumrequired
Options:own_companyservicercompetitor
originalAmountnumberrequired
originalLenderstringrequired
originalLoanDatenumberrequired
originalLoanTypestringrequired
originalRatenumber | nullrequired
originalTransactionTypestringrequired
propertyIdstringrequired
sameBorrowerboolean | nullrequired
statusenumrequired

timeout: the book could not be read in time; rows is empty and the counts are zero.

Options:oktimeout
totalnumberrequired

Rows matching the capturer (and kind), all pages.

truncatedbooleanrequired

A scan hit its row cap; counts cover the rows read.

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.