CRM

Current-sponsor office location + sponsored flag for a set of LOs

postapi.modelmatch.com/v1/crm/lo-sponsor-location

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

nmlsIdsstring[]required

Bare NMLS ids (deduped, empties dropped, capped 2000).

Responses

200objectPer-NMLS current-sponsor office location (optional) + sponsored flag. Ids not on file are omitted.

Show attributes

dataobjectrequired

Show child attributes

[key: string]object

Show child attributes

locationstring

sponsoredbooleanrequired

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/lo-sponsor-location" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nmlsIds": [
      "<string>"
    ]
  }'

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

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

const { data, error } = await Crm.crmLoSponsorLocation({
  body: {
    nmlsIds: [
      "<string>"
    ]
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/lo-sponsor-location",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "nmlsIds": [
            "<string>"
        ]
    },
)
data = res.json()

200 response

{
  "data": {
    "key": {
      "location": "<string>",
      "sponsored": true
    }
  }
}