Companies

Real-estate agents who co-closed with this company's LOs

POST
/v1/companies/{nmlsId}/breakdowns/agents

Ranks the real-estate agents on the selling side of this company's loans, by volume. Buckets whose name is an placeholder for "no selling agent recorded" (non member, non listed agent, and ~140 board-specific spellings) are excluded rather than ranked as agents — they are not people and cannot be resolved with GET /v1/agents/{id}. Percentages are shares of the company's whole loan population, so they do not sum to 100 across the page.

Authorization

x-api-key<token>

In: header

Path Parameters

nmlsId*string

Company 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/companies/string/breakdowns/agents" \  -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
}

Cancel a bulk-delivery job for companies DELETE

Cancels a queued or running companies 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/companies/bulk-delivery/{jobId}` for the settled state.

Configurable chart (measure × slice) over company's loans POST

Next Page