CRM

Find an existing CRM record by NMLS id

getapi.modelmatch.com/v1/crm/records/by-nmls

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

nmlsIdstringrequired

Bare NMLS id.

entityTypesstring

Comma-separated entity types to match (default: all).

Responses

200objectThe matching record ref, or null when none exists.

Show attributes

dataobject | nullrequired

Show child attributes

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

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/crm/records/by-nmls?nmlsId=%3Cstring%3E" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

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

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

const { data, error } = await Crm.findCrmRecordByNmls({
  query: {
    nmlsId: "<nmlsId>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/records/by-nmls?nmlsId=%3Cstring%3E",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": {
    "entityId": "<string>",
    "entityType": "lo"
  }
}