Properties

Enrich a property with owner contact info

POST
/v1/properties/{id}/enrich

Looks up owner contact information via skip-trace. Uses the canonical address first; falls back to an associated loan or sale record address if the canonical is missing. The response also carries property — the parcel's Community Lending neighborhood profile and its mortgage party rosters, the same blocks GET /v1/properties/{id} returns — so the two questions that follow a skip-trace do not need a second call. property is null when the id resolves to more than one parcel and the request was served from cache (a fresh lookup 409s instead, rather than bill for a guess).

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

Property document ID. Use the id or mmPropertyId returned by a property search/detail, or the mmPropertyId on a loan/sale record (e.g. mm_37035375304734463). Do NOT pass a bare APN, a fips+apn string, or a loan_… id — those will not resolve.

Query Parameters

refresh?string

When 'true', bypass both the per-member entitlement and the internal property cache, force a fresh skip-trace, and re-charge the user. Default: 'false'.

Value in"true" | "false"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/properties/string/enrich"
{
  "cached": true,
  "charged": true,
  "data": {
    "enrichedAt": "string",
    "persons": [
      {
        "death": {
          "deceased": true,
          "property1": null,
          "property2": null
        },
        "dnc": {
          "tcpa": true,
          "property1": null,
          "property2": null
        },
        "emails": [
          {
            "email": "string",
            "tested": true
          }
        ],
        "litigator": true,
        "mailingAddress": {
          "addressValidity": "string",
          "city": "string",
          "county": "string",
          "formattedStreet": "string",
          "hash": "string",
          "houseNumber": "string",
          "state": "string",
          "street": "string",
          "streetNoUnit": "string",
          "zip": "string",
          "zipPlus4": "string",
          "property1": null,
          "property2": null
        },
        "meta": {
          "error": "string",
          "matched": true,
          "property1": null,
          "property2": null
        },
        "name": {
          "first": "string",
          "full": "string",
          "last": "string",
          "middle": "string"
        },
        "phoneNumbers": [
          {
            "carrier": "string",
            "dnc": true,
            "lastReportedDate": "string",
            "number": "string",
            "reachable": true,
            "score": 0,
            "tested": true,
            "type": "string"
          }
        ],
        "propertyAddress": {
          "addressValidity": "string",
          "city": "string",
          "county": "string",
          "formattedStreet": "string",
          "hash": "string",
          "houseNumber": "string",
          "state": "string",
          "street": "string",
          "streetNoUnit": "string",
          "zip": "string",
          "zipPlus4": "string",
          "property1": null,
          "property2": null
        },
        "property1": null,
        "property2": null
      }
    ],
    "source": "string"
  },
  "property": {
    "communityLending": {
      "affordableHousingTract": true,
      "difficultDevelopmentArea": true,
      "distressedTract": true,
      "floodHazardTract": true,
      "lowModIncomeTract": true,
      "majorityMinorityTract": true,
      "milesToCollege": 0,
      "milesToSchool": 0,
      "milesToWorship": 0,
      "opportunityZone": true,
      "ruralTract": true,
      "tractApplications": 0,
      "tractAsianPct": 0,
      "tractBlackPct": 0,
      "tractCountyCode": "string",
      "tractDenialRate": 0,
      "tractFamilyIncome": 0,
      "tractFloodZone": "string",
      "tractHispanicPct": 0,
      "tractHomeownershipRate": 0,
      "tractHouseholdIncome": 0,
      "tractId": "string",
      "tractIncomeLevel": "low",
      "tractIncomeVsMetroPct": 0,
      "tractLoanVolume": 0,
      "tractMedianAge": 0,
      "tractMedianHomeValue": 0,
      "tractMinorityPct": 0,
      "tractOriginations": 0,
      "tractPopulation": 0,
      "tractPovertyRate": 0,
      "tractRuralGradient": 0,
      "tractStateCode": "string",
      "tractWhiteNonHispanicPct": 0,
      "usdaEligibleTract": true
    },
    "parties": {
      "active": {
        "brokers": [
          "string"
        ],
        "companies": [
          "string"
        ],
        "lenders": [
          "string"
        ],
        "originators": [
          "string"
        ]
      },
      "alltime": {
        "brokers": [
          "string"
        ],
        "companies": [
          "string"
        ],
        "lenders": [
          "string"
        ],
        "originators": [
          "string"
        ]
      },
      "last": {
        "originators": [
          "string"
        ]
      },
      "matched": {
        "brokers": [
          "string"
        ],
        "companies": [
          "string"
        ],
        "lenders": [
          "string"
        ],
        "originators": [
          "string"
        ]
      }
    }
  },
  "reason": "member_cache_hit",
  "result": {
    "error": 0,
    "matched": 0,
    "noMatch": 0,
    "requested": 0
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "balance": 0,
  "cost": 0,
  "error": "payment_required",
  "message": "string",
  "reason": "out_of_credits"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "alternates": [
    "string"
  ],
  "error": "string"
}
{
  "category": "string",
  "error": "rate_limited",
  "limit": 0,
  "message": "string",
  "requested": 0,
  "used": 0
}
{
  "error": "string"
}