Signals

This loan officer's past clients most at risk of going elsewhere

getapi.modelmatch.com/v1/originators/{nmlsId}/signals/client-retention

Client Retention Risk: this loan officer's past clients (properties they financed between six months and ten years ago), ordered by priority (highest first): the clients most at risk of taking their next refinance or equity loan to a different loan officer come first. Each row has the property, the last loan this loan officer made on it, a priority score (0–1, higher is higher priority; risk carries the same value), its priority percentile among all scored past clients, and up to three plain-language reasons. Returns an empty data list when the loan officer is scored but has no past clients in scope; 404 when the loan officer is not scored at all. Pages with limit / cursor. 1 credit per row returned.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Loan officer NMLS ID

Query parameters

limitintegerdefault: 25

Rows per page (1–100, default 25)

cursorstring

Opaque cursor from the previous page's cursor.

Responses

200objectA page of past clients, most at risk first

Show attributes

cursorstring

Pass as cursor for the next page. Absent on the last page.

dataobject[]required

Show child attributes

addressstring | nullrequired

citystring | nullrequired

lastLoanDatestring | nullrequired

Date of this loan officer's most recent loan on the property.

lastLoanTypestring | nullrequired

Type of that loan, e.g. "FHA" or "Home equity".

percentilenumberrequired

Priority percentile, 0–100: where this priority score sits among everyone scored nationally for this signal (all scored loan officers, past clients, or agent relationships). 100 = highest priority. On the state list it is still the national percentile, not a within-state one.

propertyIdstringrequired

rankintegerrequired

1 = highest priority.

reasonsstring[]required

Up to three plain-language reasons this row is a priority.

risknumberrequired

Same value as score for this signal: higher means more at risk of taking the next refinance or equity loan elsewhere.

scorenumberrequired

Priority score (0–1) for reaching out to this past client before their next refinance or equity loan goes to someone else; higher is higher priority.

scoredAtstringrequired

When this score was computed (ISO 8601).

statestring | nullrequired

zipstring | nullrequired

400objectInvalid parameters or cursor

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectThis loan officer has no predictive scores.

503objectSignals are temporarily unavailable. Retry later.

curl -X GET "https://api.modelmatch.com/v1/originators/7206/signals/client-retention" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

const res = await fetch("https://api.modelmatch.com/v1/originators/7206/signals/client-retention", {
  method: "GET",
  headers: {
    "x-api-key": process.env.MODEL_MATCH_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/originators/7206/signals/client-retention",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "cursor": "<string>",
  "data": [
    {
      "address": "<string>",
      "city": "<string>",
      "lastLoanDate": "<string>",
      "lastLoanType": "<string>",
      "percentile": 123.45,
      "propertyId": "<string>",
      "rank": 123,
      "reasons": [
        "<string>"
      ],
      "risk": 123.45,
      "score": 123.45,
      "scoredAt": "<string>",
      "state": "<string>",
      "zip": "<string>"
    }
  ]
}