Submit a bulk-delivery job for loans

Loans crediting this agent (GET /v1/agents/{id}) — the rows' *AgentId; see agentRole. ≤ 10,000 candidate loans in scope (else 400).

agentId's role: sold, list, coList, listing (list or co-list), any (default).

ModelMatch-derived loan position: whether the borrower on THIS loan is still the property's current owner. Codes read as [purpose_](C|P)W(N|C)LO — CW = current owner, PW = previous owner; NLO = a different originator than the prior loan, CLO = the same one (the retention signal).

CURRENT OWNER — Current (no newer loan), R_CWCLO/R_CWNLO (refinanced), E_CWCLO/E_CWNLO (took equity). For "past clients still in the home" pass ALL FIVE: "Current" on its own silently drops ~5M loans whose borrower is still there but has since refinanced or tapped equity.

PREVIOUS OWNER — PSALE (home sold), PWCLO/PWNLO (purchase loan), C_PWCLO/C_PWNLO (construction loan).

UNKNOWN — UNK_NOORIG (the property's most recent loan had no originator; ~64% of all populated values), UNK_PWCLO/UNK_PWNLO (most recent loan was not a purchase). REO_CWNLO/REO_CWCLO exist but are vanishingly rare (<300 loans total) and are not classified in the source glossary.

Only ~69% of loans carry any status, so an absent value means unknown — not "not current".

Broker shop NMLS id (digits only). A broker is a company — resolve a broker name to its NMLS id via instantSearch (or listCompanies).

Co-listing agent name.

County name (e.g. "Broward") or 5-digit FIPS code. Names resolve to FIPS server-side; include a state filter to disambiguate.

Estimated remaining principal balance (~19% populated). Approximate current equity as homeValue (AVM) minus this.

Employer/company NMLS id (digits only). Resolve a company name to its NMLS id via instantSearch.

Point-in-time equity recorded on the loan (sparse, ~10%). NOT a live current-equity figure. For HELOC/cash-out targeting on up-to-date equity, use properties search (listProperties) instead — its equity is far better populated and current.

Exclude loans brokered by this broker-shop NMLS id (digits only) — the inverse of broker.

Exclude loans in this city — the inverse of city.

Exclude loans from this lender ID ("everyone but X") — the inverse of lender, same id contract (resolve via instantSearch/listLenders). Loans with no lender stay in the results.

Exclude loans funded by this company NMLS id (digits only) — the inverse of loanCompany.

Exclude loans of this loan type — the inverse of loanType, same values (one type or a list; a list drops loans matching ANY of them). E.g. ["he", "heloc"] keeps everything but home-equity loans and HELOCs. Loans with no loan type recorded stay in the results.

Exclude loans with this originator NMLS id (digits only) — the inverse of originator. Common for 'everyone but my own shop' lists.

Exclude loans in this state (2-letter code, e.g. "CA") — the inverse of state. For "everywhere but this state" lists.

Exclude loans of this transaction type — the inverse of transactionType, same values (one type or a list; a list drops loans matching ANY of them). E.g. ["equity"] keeps purchase, refinance, construction and REO. Loans with no transaction type recorded stay in the results.

Exclude loans in this ZIP code — the inverse of zipCode.

Exact 5-digit county FIPS code (no name resolution) — the code-only escape hatch alongside county.

Radius search — { lat, lon, radius } (e.g. radius "15mi" or "24km") — around any office on the agent's record; with locationSource office the CURRENT office, production their transactions.

Roles that must have an agent: sold (buyer's), list, coList; any = at least one.

true: new construction — a sale of the property names a builder, or the loan names a builder or a builder seller of record. false: the rest. Needs a scope of ≤ 50,000 loans (else 400).

AVM (automated valuation) at the linked property (~26%, -linked). Pair with currentBalance to approximate current equity.

Include loans that have no originator NMLS id. Omitted/false (default): such loans are excluded — the vast majority are pre-2016 public records with no linkable originator. true: include them. Note that the default scopes results to loans with a known originator (~2016+ recordings).

Lender ID — the normalized lender-dictionary key, NOT a fuzzy name match. Resolve a lender via instantSearch (or listLenders) and pass the id it returns (e.g. "mortgage_rocket" or "mortgage rocket"). Underscores and letter case are normalized, so either id surface works. A stored normalized lender name (what the slice: "lender" chart buckets emit) is also accepted, so a chart bucket key filters directly. A value that is neither returns 400 rather than silently matching nothing — to search by lender NAME, use lenderName.

Lender name as recorded on the loan document — fuzzy, all-terms match (e.g. "Fifth Third"). The name counterpart to the exact-id lender filter; use lender when you have a resolved id, and this when you only have a name.

Listing agent name.

Funding/loan company NMLS id (digits only). Resolve a company name to its NMLS id via instantSearch.

Loan-to-value at ORIGINATION (sparse), as a PERCENT on a 0-100 scale (80 = 80% LTV; values above 100 are real underwater loans). This is not a current LTV — there is no stored current-LTV field on loans.

Loan originator NMLS id (digits only). To search by name use originatorName, or resolve a name to its id via instantSearch.

DEPRECATED — fuzzy name matching is unreliable (same originator can return wildly different counts by name string). Resolve the loan officer via instantSearch and filter by originator (exact NMLS id) instead. Still functional for now.

Parcel id — returns every loan recorded against one property. Pass the same string this endpoint returns as mmPropertyId on a loan row, or the mmPropertyId of a property record.

This is the parcel's FULL recorded loan history, which is deliberately wider than the loans embedded on a property record: that embed is a snapshot of what is still owed (up to five currently-active loans), so paid-off mortgages are absent from it and present here.

Multi-unit caveat: loans carry a unit-blind parcel id, so for one unit of a multi-unit building this selects every unit in the building, not that unit alone.

Every word starts a word of the address (street, city, state, ZIP), the lender name or an agent name ("12 oak", "jane sm").

Buyer's agent: every word starts a word of the name or the linked agent's name. Likewise listAgentName, coListAgentName.

Alias of zipCode — same ZIP filter, accepted for cross-entity key parity.

Opaque cursor from previous response for next page

Page size (1-100, default 25)

The response DTO field this column reads — the same names fields takes, dotted into nested objects (contact.linkedin) — or a list of them, taking the first non-empty value (["contact.personalEmail", "contact.workEmail", "email"]).

currency, number and percentWhole round the value to a whole number (in both csv and xlsx) and, in xlsx, display it as $1,234,567, 1,234 or 62%. percentWhole expects a value that is already 0–100 (it is written as 62 in csv; in xlsx the cell holds 0.62 under the standard percent format, so it displays 62% in every spreadsheet app and calculates as a percent). text writes an xlsx text cell. titleCase (dina verteramo → Dina Verteramo), lowercase, and phone (US 10-digit numbers as (469) 907-7475; anything else as stored) reshape the text and write a text cell. Omit for the value as-is.

Header for the column.

Display text per value, keyed by the value as a string ({ "true": "Branch Manager", "false": "Originator" }, { "BANK": "Bank" }). The key "null" matches an empty value. Unmatched values are written unchanged.

Id of a push target configured on the active workspace (or your own member push targets).