Properties

Get bulk enrichment job status

GET
/v1/properties/enrich-bulk/{jobId}

Authorization

x-api-key<token>

In: header

Path Parameters

jobId*string

Job ID from POST /v1/properties/enrich-bulk

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/properties/enrich-bulk/string"
{
  "billingStatus": "charged",
  "chargedCount": 0,
  "completedAt": "string",
  "creditsCharged": 0,
  "downloadUrl": "string",
  "error": "string",
  "failed": 0,
  "fromCache": 0,
  "jobId": "string",
  "resultsUrl": "string",
  "startedAt": "string",
  "status": "queued",
  "succeeded": 0,
  "total": 0
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}

Enrich a property with owner contact info POST

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).

Get bulk-delivery job status for properties GET

Next Page