Cancel a bulk-delivery job for branches
Cancels a queued or running branches delivery job.
The job is marked cancelled immediately; the container running it notices on its next page boundary and stops. Because a delivery is billed once, at the end, a cancelled job is never charged — no credits are debited and there is nothing to refund. No partial file is written.
Idempotent-ish: cancelling a job that has already finished (or was already cancelled) returns 409 and changes nothing. Poll GET /v1/branches/bulk-delivery/{jobId} for the settled state.
In: header
Path Parameters
Job ID returned by POST /v1/branches/bulk-delivery
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v1/branches/bulk-delivery/string"{
"billing": "credits",
"billingReason": "first_party_push_target",
"bytes": 0,
"chargedCount": 0,
"completedAt": "string",
"creditLedgerId": "string",
"creditsCharged": 0,
"destination": {
"targetId": "string",
"type": "push-target"
},
"downloadUrl": "string",
"entityType": "string",
"error": "string",
"estimatedTotal": 0,
"format": "parquet",
"jobId": "string",
"processed": 0,
"pushBatchId": "string",
"resultsUrl": "string",
"startedAt": "string",
"status": "queued"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}Title companies on this branch's loans (spellings merged) POST
Ranks the title companies on this entity's loans (recorded deeds, `recording_date` window — the same population and period axis as every other loans breakdown). Spellings of one company are MERGED: `label` is its most-used spelling, `id` the normalized name every spelling was grouped under (legal-form and filler words such as `inc`, `llc`, `co`, `company`, `title`, `escrow` removed; `natl` → `national`). Placeholder entries meaning "no title company recorded" (`none available` and its misspellings, `unknown`, `n/a`, …) and names shorter than 3 characters are excluded rather than ranked. `attorney` and `accommodation` are kept: they say who closed. `pctUnits` / `pctVolume` are shares of the entity's WHOLE loan population in the window, including loans with no title company, so they do not sum to 100 across the page. Pages of up to 100 via `pagination`.
Count branches matching filters POST
Return the exact number of branches matching the given filters. Accepts the same request body as `listBranches` (pagination and sort are ignored). Use this when you only need a total; to get the matching branches themselves, send the same request body to `listBranches`.