Branches

Title companies on this branch's loans (spellings merged)

POST
/v1/branches/{nmlsId}/breakdowns/title-companies

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.

Authorization

x-api-key<token>

In: header

Path Parameters

nmlsId*string

Branch NMLS ID

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/branches/string/breakdowns/title-companies" \  -H "Content-Type: application/json" \  -d '{}'
{
  "cursor": "string",
  "data": [
    {
      "company": {
        "name": "string",
        "nmlsId": "string"
      },
      "excluded": 0,
      "id": "string",
      "label": "string",
      "name": "string",
      "office": {
        "id": "string",
        "name": "string"
      },
      "pctUnits": 0,
      "pctVolume": 0,
      "units": 0,
      "volume": 0
    }
  ],
  "total": 0,
  "totals": {
    "excluded": 0,
    "units": 0,
    "volume": 0,
    "volumePlausible": true
  },
  "truncated": true
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string",
  "limit": 0,
  "size": 0
}

State volume breakdown across this branch's loans POST

Ranks the states this branch's loans were secured in, by volume. Labels are two-letter state abbreviations. This is where the branch actually transacted, which is narrower than where it is licensed — licensed states are returned by `GET /v1/branches/{nmlsId}`.

Cancel a bulk-delivery job for branches DELETE

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.