Companies

Hire cohorts and how many left within N days

getapi.modelmatch.com/v1/companies/{nmlsId}/early-exits

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Company NMLS ID

Query parameters

periodenum

Preset window when from/to are not given (default last12Months). Rolling periods start on the FIRST day of the month N months back and end today; a year is Jan 1 – Dec 31; allTime starts 2017-01-01, the earliest reliable registration data. Also selects the production period for volume/units.

Options:2017201820192020202120222023202420252026last3Monthslast6Monthslast12Monthslast14Monthslast16Monthslast18Monthslast24MonthsyearToDateallTime

fromstring

Window start, inclusive (YYYY-MM-DD). Overrides period.

tostring

Window end, inclusive (YYYY-MM-DD). Overrides period.

monthstring

Drill into one hire cohort (YYYY-MM): data then lists its early departures and recent starts.

withinDaysinteger

An exit within this many days of the start is EARLY (default 90). Also the 'recent start' and incomplete-cohort horizon.

Responses

200objectEarly-exit cohorts

Show attributes

dataobject[]

Present only with month: that cohort's rows.

Show child attributes

citystring | nullrequired

daysAtCompanynumber | nullrequired

daysSinceStartnumberrequired

endDatestring | nullrequired

kindenumrequired

Options:early_departurerecent_start

namestring | nullrequired

nextEmployerobjectrequired

Show child attributes

namestring | nullrequired

nmlsIdstring | nullrequired

nmlsIdstringrequired

previousEmployerobjectrequired

Show child attributes

namestring | nullrequired

nmlsIdstring | nullrequired

startDatestringrequired

statestring | nullrequired

trailingUnitsnumberrequired

trailingVolumenumberrequired

Trailing-12-month production across all employers (0 when none on file).

monthlyCohortsobject[]required

Show child attributes

attritionRatenumberrequired

earlyDeparturesnumberrequired

isIncompleteCohortbooleanrequired

The month ends inside the trailing withinDays, so the cohort has not had the full horizon to exit.

monthstringrequired

newHiresnumberrequired

recentStartsnumberrequired

summaryobjectrequired

Show child attributes

avgDaysBeforeExitnumberrequired

earlyAttritionRatenumberrequired

0–100.

riskLevelenumrequired

Options:low_samplecritical_attentionattention_neededreview_recommendedworth_reviewingworth_monitoringsteady_retentionstrong_retentionexceptional_retention

totalEarlyDeparturesnumberrequired

totalNewHiresnumberrequired

truncatedbooleanrequired

true when the company has more than 100,000 loan officers in scope and only the first 100,000 (by NMLS ID) were counted. false means every figure covers the full population.

windowobjectrequired

Show child attributes

fromstringrequired

tostringrequired

withinDaysnumberrequired

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 GET "https://api.modelmatch.com/v1/companies/<nmlsId>/early-exits" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

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

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

const { data, error } = await client.companies.earlyExits({
  path: {
    nmlsId: "<nmlsId>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/companies/<nmlsId>/early-exits",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": [
    {
      "city": "<string>",
      "daysAtCompany": 123.45,
      "daysSinceStart": 123.45,
      "endDate": "<string>",
      "kind": "early_departure",
      "name": "<string>",
      "nextEmployer": {
        "name": "<string>",
        "nmlsId": "<string>"
      },
      "nmlsId": "<string>",
      "previousEmployer": {
        "name": "<string>",
        "nmlsId": "<string>"
      },
      "startDate": "<string>",
      "state": "<string>",
      "trailingUnits": 123.45,
      "trailingVolume": 123.45
    }
  ],
  "monthlyCohorts": [
    {
      "attritionRate": 123.45,
      "earlyDepartures": 123.45,
      "isIncompleteCohort": true,
      "month": "<string>",
      "newHires": 123.45,
      "recentStarts": 123.45
    }
  ],
  "summary": {
    "avgDaysBeforeExit": 123.45,
    "earlyAttritionRate": 123.45,
    "riskLevel": "low_sample",
    "totalEarlyDepartures": 123.45,
    "totalNewHires": 123.45
  },
  "truncated": true,
  "window": {
    "from": "<string>",
    "to": "<string>"
  },
  "withinDays": 123.45
}