CRM

Rank an agent's LO partners by product-mix + size similarity to a viewing LO

postapi.modelmatch.com/v1/crm/similar-originators

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

dateRangestring

Period key (default: last_14_months).

partnerNmlsIdsstring[]required

Partner LO NMLS ids to rank (deduped, self-excluded, capped at 200).

topnumber

Max scored rows to return (1–50, default 25).

viewerNmlsstringrequired

The viewing LO's bare NMLS id.

weightsobject

Live tuning overrides for the tx/loan/size blend (clamped to ≥ 0).

Show child attributes

loannumber

sizenumber

txnumber

Responses

200objectScored + sorted partner LOs (score, per-component similarity, shared highlight).

Show attributes

dataobjectrequired

Show child attributes

resultsobject[]required

Show child attributes

componentsobjectrequired

highlightobject | nullrequired

nmlsstringrequired

scorenumberrequired

unitsnumberrequired

volumenumberrequired

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/crm/similar-originators" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "partnerNmlsIds": [
      "<string>"
    ],
    "viewerNmls": "<string>",
    "dateRange": "<string>",
    "top": 123.45
  }'

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

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

const { data, error } = await Crm.crmSimilarOriginators({
  body: {
    partnerNmlsIds: [
      "<string>"
    ],
    viewerNmls: "<string>",
    dateRange: "<string>",
    top: 123.45
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/similar-originators",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "partnerNmlsIds": [
            "<string>"
        ],
        "viewerNmls": "<string>",
        "dateRange": "<string>",
        "top": 123.45
    },
)
data = res.json()

200 response

{
  "data": {
    "results": [
      {
        "components": {
          "loan": 123.45,
          "size": 123.45,
          "tx": 123.45
        },
        "highlight": {
          "partnerPct": 123.45,
          "type": "<string>"
        },
        "nmls": "<string>",
        "score": 123.45,
        "units": 123.45,
        "volume": 123.45
      }
    ]
  }
}