Properties

Submit a bulk skip-trace job

POST
/v1/properties/enrich-bulk

Queues an ECS task that enriches up to 50000 properties. Returns 202 with a jobId; poll GET /v1/properties/enrich-bulk/{jobId} or subscribe to the enrichment.bulk.* EventBridge / webhook events for completion.

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/properties/enrich-bulk" \  -H "Content-Type: application/json" \  -d '{}'
{
  "estimatedCost": 0,
  "jobId": "string",
  "propertyCount": 0,
  "status": "queued"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "balance": 0,
  "cost": 0,
  "error": "payment_required",
  "message": "string",
  "reason": "out_of_credits"
}
{
  "category": "enrichment",
  "error": "daily_limit_exceeded",
  "limit": 0,
  "message": "string",
  "requested": 0,
  "used": 0
}
{
  "error": "string"
}

Enrich several properties with owner contact info in one request POST

Looks up owner contact information for up to 50 properties in a single synchronous request. Each id is resolved independently and returned in the `results` array with its own status — a bad id never fails the batch. Each match debits one credit; cache hits and no-matches are free. Every ok item also carries `property` — the parcel's Community Lending neighborhood profile and mortgage party rosters. For larger sets use the asynchronous bulk job.

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