Properties

Flag a transaction on a property's history

postapi.modelmatch.com/v1/properties/{mmPropertyId}/transaction-flags

Report that a listing, sale or mortgage on a property's history looks wrong — a wrong loan amount, loan officer or company, a duplicate, missing details, or a missing transaction. The flag is reviewed by the Model Match data team; this call only records it and answers immediately. Flagging the same transaction for the same reason again while the first flag is still open returns the first flag's id.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

mmPropertyIdstringrequired

The property's mmPropertyId.

Body application/json

addressstringrequired

The property's address as the user saw it.

detailsstring

What is wrong, in the user's words (up to 2000 characters). Markup and control characters are removed.

eventDatestringrequired

The row's date as shown (ISO date preferred).

eventIdstringrequired

The listing / sale / loan id of the history row being flagged.

eventSummarystringrequired

The row's one-line summary as shown.

eventTypeenumrequired

Options:listingsoldmortgage

profileobject

The profile the user flagged it from, when there was one.

Show child attributes

idstringrequired

typeenumrequired

Options:agentloan-officercompany

urlstring

Link to the profile in the app. Ignored unless it is a public http(s) URL.

reasonenumrequired

Options:wrong-loan-amountwrong-lo-or-companywrong-property-detailsduplicatemissing-detailsmissing-transactionother

Responses

202objectRecorded. Review happens afterwards.

Show attributes

dataobjectrequired

Show child attributes

idstringrequired

The flag id.

400objectValidation error

401objectUnauthorized

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

404objectNot found

413objectThe request body is too large.

415objectThe body must be sent as `application/json`.

429objectToo many flags in the last 24 hours. Try again later.

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X POST "https://api.modelmatch.com/v1/properties/mm_37035375304734463/transaction-flags" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "123 Main St, Austin, TX 78701",
    "eventDate": "2026-04-12",
    "eventId": "loan_abc123",
    "eventSummary": "$450,000 · Conventional · Acme Mortgage",
    "eventType": "listing",
    "reason": "wrong-loan-amount",
    "details": "<string>"
  }'

const res = await fetch("https://api.modelmatch.com/v1/properties/mm_37035375304734463/transaction-flags", {
  method: "POST",
  headers: {
    "x-api-key": process.env.MODEL_MATCH_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address": "123 Main St, Austin, TX 78701",
    "eventDate": "2026-04-12",
    "eventId": "loan_abc123",
    "eventSummary": "$450,000 · Conventional · Acme Mortgage",
    "eventType": "listing",
    "reason": "wrong-loan-amount",
    "details": "<string>"
  }),
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/properties/mm_37035375304734463/transaction-flags",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "address": "123 Main St, Austin, TX 78701",
        "eventDate": "2026-04-12",
        "eventId": "loan_abc123",
        "eventSummary": "$450,000 · Conventional · Acme Mortgage",
        "eventType": "listing",
        "reason": "wrong-loan-amount",
        "details": "<string>"
    },
)
data = res.json()

202 response

{
  "data": {
    "id": "<string>"
  }
}