Originators

Loans one capturer took from this LO

postapi.modelmatch.com/v1/originators/{nmlsId}/retention/captured

The loss rows (churnedLoans shape) one capturing loan officer — or company — took from this LO's borrowers in start–end, newest first, paged. Same classification as originatorRetention, so total matches that capturer's count there; unlike the report, it is not limited to the newest 500 rows overall.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Originator NMLS ID

Body application/json

capturingCompanyNmlsIdstring

The capturing company (a capturingCompanies[].nmlsId). Exactly one of the two capturer ids is required.

capturingLoNmlsIdstring

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

endstringrequired

Last day of the period (UTC, inclusive).

kindenum

Only refinances or only second liens. Default both.

Options:refisecond

limitinteger

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

offsetinteger

Rows to skip (newest first).

startstringrequired

First day of the period (UTC).

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.

curl -X POST "https://api.modelmatch.com/v1/originators/<nmlsId>/retention/captured" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "end": "2025-08-15",
    "start": "2025-08-15",
    "kind": "refi",
    "capturingCompanyNmlsId": "<string>",
    "capturingLoNmlsId": "<string>",
    "limit": 123,
    "offset": 123
  }'

import { createClient } from "@model-match/api";

const client = createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await client.originators.retentionCaptured({
  path: {
    nmlsId: "<nmlsId>"
  },
  body: {
    end: "2025-08-15",
    start: "2025-08-15",
    kind: "refi",
    capturingCompanyNmlsId: "<string>",
    capturingLoNmlsId: "<string>",
    limit: 123,
    offset: 123
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/originators/<nmlsId>/retention/captured",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "end": "2025-08-15",
        "start": "2025-08-15",
        "kind": "refi",
        "capturingCompanyNmlsId": "<string>",
        "capturingLoNmlsId": "<string>",
        "limit": 123,
        "offset": 123
    },
)
data = res.json()

200 response

{
  "counts": {
    "refi": 123.45,
    "second": 123.45
  },
  "rows": [
    {
      "address": "<string>",
      "borrower": "<string>",
      "capturingAmount": 123.45,
      "capturingCompany": "<string>",
      "capturingCompanyNmlsId": "<string>",
      "capturingLender": "<string>",
      "capturingLoName": "<string>",
      "capturingLoNmlsId": "<string>",
      "capturingLoanType": "<string>",
      "capturingRate": 123.45,
      "cashOut": true,
      "current": {
        "currentBalance": 123.45,
        "currentLender": "<string>",
        "currentRate": 123.45,
        "lastSaleDate": 123.45,
        "loStillActive": true,
        "ownerChanged": true
      },
      "daysToEvent": 123.45,
      "eventDate": 123.45,
      "kind": "refi",
      "lane": "own_company",
      "originalAmount": 123.45,
      "originalLender": "<string>",
      "originalLoanDate": 123.45,
      "originalLoanType": "<string>"
    }
  ],
  "status": "ok",
  "total": 123.45,
  "truncated": true
}