@model-match/api 3.50.0 → 3.51.0

package/openapi.json

@@ -8142,7 +8142,7 @@
                 "$ref": "#/components/schemas/BranchSlice"
               },
               {
-                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice`, and cannot be combined with `size` / `after` paging (400)."
+                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice` (400). Combines with `size` / `after` paging on a party slice: the cursor pages the `slice` ranking and every bucket on each page carries its own segments (e.g. `slice: \"broker\", segment: \"lender\"` walks every broker shop × its lenders)."
               }
             ]
           },
@@ -9460,6 +9460,50 @@
         ],
         "type": "string"
       },
+      "BranchStatsResponse": {
+        "properties": {
+          "data": {
+            "properties": {
+              "avgLoCount": {
+                "description": "Mean current roster size (`loCount`) across matching branches; `null` when none carry one. A snapshot — does not vary by period.",
+                "nullable": true,
+                "type": "number"
+              },
+              "branches": {
+                "description": "Branches matching the request — equals `countBranches.total`.",
+                "type": "integer"
+              },
+              "producingBranches": {
+                "description": "Matching branches with at least one loan (units > 0) in the period.",
+                "type": "integer"
+              },
+              "topUnits": {
+                "description": "Units of the 3 highest-unit matching branches, descending. Divide their sum by `totalUnits` for top-3 concentration.",
+                "items": {
+                  "type": "number"
+                },
+                "type": "array"
+              },
+              "totalUnits": {
+                "description": "Sum of the period's branch-level units.",
+                "type": "number"
+              }
+            },
+            "required": [
+              "branches",
+              "producingBranches",
+              "avgLoCount",
+              "totalUnits",
+              "topUnits"
+            ],
+            "type": "object"
+          }
+        },
+        "required": [
+          "data"
+        ],
+        "type": "object"
+      },
       "BranchSummary": {
         "properties": {
           "avgLoanAmount": {
@@ -11079,6 +11123,16 @@
             ],
             "type": "string"
           },
+          "billingStatus": {
+            "description": "Outcome of the job's single debit, taken before anything is delivered: `charged`, `capped` (balance / spend cap / daily cap declined it — the job fails `insufficient_credits`), `billing_error` (the debit could not be made — the job fails `billing_unavailable`), or `none` (nothing to bill: free delivery or zero rows). Absent until billing has run, and on older jobs.",
+            "enum": [
+              "charged",
+              "capped",
+              "billing_error",
+              "none"
+            ],
+            "type": "string"
+          },
           "bytes": {
             "minimum": 0,
             "type": "integer"
@@ -11096,7 +11150,7 @@
             "type": "string"
           },
           "creditsCharged": {
-            "description": "Credits debited for this job (1 credit / row). Absent until the job completes; absent on a failed billing call.",
+            "description": "Credits ACTUALLY debited for this job (1 credit / row) — `0` when the debit was declined or failed; read `billingStatus` for why. Absent until billing has run.",
             "minimum": 0,
             "type": "number"
           },
@@ -11111,7 +11165,7 @@
             "type": "string"
           },
           "error": {
-            "description": "Why the job failed. `push_handoff_failed` = the rows were exported but could not be handed to the push target (not billed).",
+            "description": "Why the job failed. `insufficient_credits` = the charge was declined (balance, spend cap or daily cap), nothing delivered. `billing_unavailable` = the charge could not be made, nothing delivered — retry. `push_handoff_failed` = the rows were exported and charged but could not be handed to the push target (see `billingStatus`).",
             "type": "string"
           },
           "estimatedTotal": {
@@ -11328,6 +11382,167 @@
         ],
         "type": "object"
       },
+      "CommunityLendingBenchmark": {
+        "description": "Peer rank of an entity's neighborhood lending shares. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+        "nullable": true,
+        "properties": {
+          "lowModIncomeTract": {
+            "properties": {
+              "pct": {
+                "description": "This entity's share, 0-100.",
+                "nullable": true,
+                "type": "number"
+              },
+              "peerAvgPct": {
+                "description": "Peer mean share, 0-100. Null with no peers.",
+                "nullable": true,
+                "type": "number"
+              },
+              "percentileRank": {
+                "description": "0-100: share of peers with a lower value. Null when this entity has no value or there are no peers.",
+                "nullable": true,
+                "type": "number"
+              }
+            },
+            "required": [
+              "pct",
+              "percentileRank",
+              "peerAvgPct"
+            ],
+            "type": "object"
+          },
+          "majorityMinorityTract": {
+            "properties": {
+              "pct": {
+                "description": "This entity's share, 0-100.",
+                "nullable": true,
+                "type": "number"
+              },
+              "peerAvgPct": {
+                "description": "Peer mean share, 0-100. Null with no peers.",
+                "nullable": true,
+                "type": "number"
+              },
+              "percentileRank": {
+                "description": "0-100: share of peers with a lower value. Null when this entity has no value or there are no peers.",
+                "nullable": true,
+                "type": "number"
+              }
+            },
+            "required": [
+              "pct",
+              "percentileRank",
+              "peerAvgPct"
+            ],
+            "type": "object"
+          },
+          "peerPopulation": {
+            "type": "number"
+          },
+          "states": {
+            "description": "The footprint states peers were drawn from (top by units). Empty = nationwide.",
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          }
+        },
+        "required": [
+          "states",
+          "peerPopulation",
+          "lowModIncomeTract",
+          "majorityMinorityTract"
+        ],
+        "type": "object"
+      },
+      "CommunityLendingBenchmarkResponse": {
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/CommunityLendingBenchmark"
+          }
+        },
+        "required": [
+          "data"
+        ],
+        "type": "object"
+      },
+      "CommunityLendingMapPoint": {
+        "properties": {
+          "address": {
+            "nullable": true,
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "lat": {
+            "type": "number"
+          },
+          "lon": {
+            "type": "number"
+          },
+          "mortgageAmount": {
+            "nullable": true,
+            "type": "number"
+          },
+          "tractGeoId": {
+            "description": "11-digit Census tract GEOID (state + county + tract FIPS) — the join key for a tract boundary layer.",
+            "nullable": true,
+            "type": "string"
+          },
+          "transactionDate": {
+            "nullable": true,
+            "type": "string"
+          },
+          "transactionType": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "lat",
+          "lon",
+          "address",
+          "mortgageAmount",
+          "transactionDate",
+          "transactionType",
+          "tractGeoId"
+        ],
+        "type": "object"
+      },
+      "CommunityLendingMapResponse": {
+        "properties": {
+          "points": {
+            "items": {
+              "$ref": "#/components/schemas/CommunityLendingMapPoint"
+            },
+            "type": "array"
+          },
+          "total": {
+            "description": "Every geocoded loan in scope for the period.",
+            "type": "number"
+          },
+          "tractCounts": {
+            "additionalProperties": {
+              "type": "number"
+            },
+            "description": "Plotted loans per tract GEOID. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+            "type": "object"
+          },
+          "truncated": {
+            "description": "More than 4000 loans matched; the newest are returned.",
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "points",
+          "tractCounts",
+          "total",
+          "truncated"
+        ],
+        "type": "object"
+      },
       "CompanyBranch": {
         "properties": {
           "branchNmlsId": {
@@ -12407,7 +12622,7 @@
                 "$ref": "#/components/schemas/CompanySlice"
               },
               {
-                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice`, and cannot be combined with `size` / `after` paging (400)."
+                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice` (400). Combines with `size` / `after` paging on a party slice: the cursor pages the `slice` ranking and every bucket on each page carries its own segments (e.g. `slice: \"broker\", segment: \"lender\"` walks every broker shop × its lenders)."
               }
             ]
           },
@@ -18834,11 +19049,13 @@
             "type": "string"
           },
           "outcome": {
-            "description": "Reporting classification (`status` fields only). Absent = in-progress. Seed ids `won`/`lost` classify by convention when unset.",
+            "description": "Reporting classification (`status` fields only). Absent = in-progress. Seed ids `won`/`lost` classify by convention when absent; `null` explicitly un-classifies them (in-progress).",
             "enum": [
               "won",
-              "lost"
+              "lost",
+              null
             ],
+            "nullable": true,
             "type": "string"
           }
         },
@@ -27017,6 +27234,10 @@
                   }
                 ]
               },
+              "reverseRefinance": {
+                "description": "HECM-to-HECM. `true`: keep only reverse loans recorded AFTER an earlier reverse loan (≥ $1,000) on the same property — a refinance of an existing reverse mortgage, resolved from the property's loan history because the transaction type does not record it. Pair with `loanType: \"reverse\"`. Resolves up to 50,000 distinct properties per request (else 400). Chart only.",
+                "type": "boolean"
+              },
               "saleDate": {
                 "$ref": "#/components/schemas/DateFilterValue"
               },
@@ -27057,7 +27278,7 @@
                 "$ref": "#/components/schemas/LoanSlice"
               },
               {
-                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice`, and cannot be combined with `size` / `after` paging (400)."
+                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice` (400). Combines with `size` / `after` paging on a party slice: the cursor pages the `slice` ranking and every bucket on each page carries its own segments (e.g. `slice: \"broker\", segment: \"lender\"` walks every broker shop × its lenders)."
               }
             ]
           },
@@ -32798,7 +33019,7 @@
                 "$ref": "#/components/schemas/OriginatorSlice"
               },
               {
-                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice`, and cannot be combined with `size` / `after` paging (400)."
+                "description": "Optional second dimension. Each bucket of `slice` then carries `segments`: the same `measure` broken down by this dimension (e.g. `slice: \"loanType\", segment: \"lender\"` is loan type × lender in one call), top 25 per bucket ranked by `measure`, with the remainder counted in `segmentsOmittedCount`. Omit it and the response is the one-dimensional chart, unchanged. Must differ from `slice` (400). Combines with `size` / `after` paging on a party slice: the cursor pages the `slice` ranking and every bucket on each page carries its own segments (e.g. `slice: \"broker\", segment: \"lender\"` walks every broker shop × its lenders)."
               }
             ]
           },
@@ -43927,7 +44148,7 @@
   "info": {
     "description": "ModelMatch API — mortgage and real-estate market data.\n\n## Bulk delivery limits\n\nThe `POST /{entity}/bulk-delivery` endpoints export a full result set to\nS3 as NDJSON, JSON, CSV, or Parquet.\n\n- **Up to 5,000 rows per delivery: no entitlement required.** Available to\n  every authenticated caller.\n- **Above 5,000 rows: requires the entity's `bulk-delivery.{entity}`\n  entitlement** (e.g. `bulk-delivery.loans`). The grant's scope sets your\n  row ceiling and may also restrict which rows and fields you receive.\n\nA delivery that would exceed the limit available to you is rejected with\n`403 entitlement_missing`, reporting the matched row count and the ceiling\nthat applied. To stay under the limit, pass `limit` — the job then delivers\n(and bills for) only the first `limit` rows of a broader query.\n\n**Need a higher limit?** Email support@modelmatch.com to request the\nentitlement. Limits are raised per organization and per entity.\n\nBulk delivery is billed at 1 credit per delivered row whether or not\nan entitlement is held.\n\nInstead of a download, a delivery can be sent to a push target configured\non your workspace: pass `destination: { type: \"push-target\", targetId }`.\nThe same limits and billing apply.",
     "title": "ModelMatch API",
-    "version": "3.112.0"
+    "version": "3.116.1"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -44454,7 +44675,7 @@
                 }
               }
             },
-            "description": "Preflight / S3 / DDB / ECS launch failure, or the push-target check could not reach the auth server"
+            "description": "Preflight / S3 / DDB / ECS launch failure, the push-target check could not reach the auth server, or the credit balance could not be read (`billing_unavailable` — retry; a paid delivery is never queued unverified)"
           }
         },
         "summary": "Submit a bulk-delivery job for agents",
@@ -50254,7 +50475,7 @@
                 }
               }
             },
-            "description": "Preflight / S3 / DDB / ECS launch failure, or the push-target check could not reach the auth server"
+            "description": "Preflight / S3 / DDB / ECS launch failure, the push-target check could not reach the auth server, or the credit balance could not be read (`billing_unavailable` — retry; a paid delivery is never queued unverified)"
           }
         },
         "summary": "Submit a bulk-delivery job for branches",
@@ -50490,6 +50711,97 @@
         "x-mm-records-via": "listBranches"
       }
     },
+    "/v1/branches/stats": {
+      "post": {
+        "description": "Accepts the same request body as `listBranches` (pagination and sort are ignored) and returns aggregate KPIs over every matching branch: count, producing count, average roster size, total units and the top 3 branches' units. Use it for a company's branch network summary (`flatFilters.company`).",
+        "operationId": "branchStats",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BranchListRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BranchStatsResponse"
+                }
+              }
+            },
+            "description": "Branch roll-up KPIs"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value."
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Roll-up KPIs over the branches matching filters",
+        "tags": [
+          "Branches"
+        ]
+      }
+    },
     "/v1/branches/{nmlsId}": {
       "get": {
         "description": "Retrieve full details for a single NMLS mortgage branch including name, address, parent company, managers, trade names, licensing, and branch-level production for the selected period.",
@@ -50853,16 +51165,119 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Lenders this branch originated through",
+        "summary": "Lenders this branch originated through",
+        "tags": [
+          "Branches"
+        ]
+      }
+    },
+    "/v1/branches/{nmlsId}/breakdowns/originators": {
+      "post": {
+        "description": "Ranks the loan officers whose loans public record attributes to this branch, by volume. Each label is the LO's NMLS ID, so it chains straight into `GET /v1/originators/{nmlsId}`. This is the branch's RECORDED roster, not its licensing roster: it answers who actually wrote loans here in the period, which is narrower than everyone registered to the branch and can include someone who has since moved. For the licensed managers on file, read `managers` on `GET /v1/branches/{nmlsId}`.",
+        "operationId": "branchOriginators",
+        "parameters": [
+          {
+            "description": "Branch NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Branch NMLS ID",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/BreakdownRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BreakdownResponse"
+                }
+              }
+            },
+            "description": "Breakdown of this branch's loans by originators"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Loan officers who wrote this branch's loans",
         "tags": [
           "Branches"
         ]
       }
     },
-    "/v1/branches/{nmlsId}/breakdowns/originators": {
+    "/v1/branches/{nmlsId}/breakdowns/states": {
       "post": {
-        "description": "Ranks the loan officers whose loans public record attributes to this branch, by volume. Each label is the LO's NMLS ID, so it chains straight into `GET /v1/originators/{nmlsId}`. This is the branch's RECORDED roster, not its licensing roster: it answers who actually wrote loans here in the period, which is narrower than everyone registered to the branch and can include someone who has since moved. For the licensed managers on file, read `managers` on `GET /v1/branches/{nmlsId}`.",
-        "operationId": "branchOriginators",
+        "description": "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}`.",
+        "operationId": "branchStates",
         "parameters": [
           {
             "description": "Branch NMLS ID",
@@ -50893,7 +51308,7 @@
                 }
               }
             },
-            "description": "Breakdown of this branch's loans by originators"
+            "description": "Breakdown of this branch's loans by states"
           },
           "400": {
             "content": {
@@ -50956,16 +51371,16 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Loan officers who wrote this branch's loans",
+        "summary": "State volume breakdown across this branch's loans",
         "tags": [
           "Branches"
         ]
       }
     },
-    "/v1/branches/{nmlsId}/breakdowns/states": {
+    "/v1/branches/{nmlsId}/breakdowns/title-companies": {
       "post": {
-        "description": "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}`.",
-        "operationId": "branchStates",
+        "description": "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`.",
+        "operationId": "branchTitleCompanies",
         "parameters": [
           {
             "description": "Branch NMLS ID",
@@ -50996,7 +51411,7 @@
                 }
               }
             },
-            "description": "Breakdown of this branch's loans by states"
+            "description": "Breakdown of the entity's loans by title company"
           },
           "400": {
             "content": {
@@ -51059,47 +51474,54 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "State volume breakdown across this branch's loans",
+        "summary": "Title companies on this branch's loans (spellings merged)",
         "tags": [
           "Branches"
         ]
       }
     },
-    "/v1/branches/{nmlsId}/breakdowns/title-companies": {
-      "post": {
-        "description": "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`.",
-        "operationId": "branchTitleCompanies",
+    "/v1/branches/{nmlsId}/community-lending/map": {
+      "get": {
+        "description": "Map points for loans written by this branch's current roster in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.",
+        "operationId": "branchCommunityLendingMap",
         "parameters": [
           {
-            "description": "Branch NMLS ID",
+            "description": "Branche NMLS ID",
             "in": "path",
             "name": "nmlsId",
             "required": true,
             "schema": {
-              "description": "Branch NMLS ID",
+              "description": "Branche NMLS ID",
               "type": "string"
             }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
-              }
+          },
+          {
+            "description": "Period window (default: last12Months).",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Period window (default: last12Months)."
+                }
+              ]
             }
           }
-        },
+        ],
         "responses": {
           "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/BreakdownResponse"
+                  "$ref": "#/components/schemas/CommunityLendingMapResponse"
                 }
               }
             },
-            "description": "Breakdown of the entity's loans by title company"
+            "description": "Map feed"
           },
           "400": {
             "content": {
@@ -51162,7 +51584,7 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Title companies on this branch's loans (spellings merged)",
+        "summary": "Community Lending map: geocoded loans + per-tract counts",
         "tags": [
           "Branches"
         ]
@@ -51897,7 +52319,7 @@
                 }
               }
             },
-            "description": "Preflight / S3 / DDB / ECS launch failure, or the push-target check could not reach the auth server"
+            "description": "Preflight / S3 / DDB / ECS launch failure, the push-target check could not reach the auth server, or the credit balance could not be read (`billing_unavailable` — retry; a paid delivery is never queued unverified)"
           }
         },
         "summary": "Submit a bulk-delivery job for companies",
@@ -53328,47 +53750,259 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "State volume breakdown across this company's loans",
+        "summary": "State volume breakdown across this company's loans",
+        "tags": [
+          "Companies"
+        ]
+      }
+    },
+    "/v1/companies/{nmlsId}/breakdowns/title-companies": {
+      "post": {
+        "description": "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`.",
+        "operationId": "companyTitleCompanies",
+        "parameters": [
+          {
+            "description": "Company NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Company NMLS ID",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BreakdownResponse"
+                }
+              }
+            },
+            "description": "Breakdown of the entity's loans by title company"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Title companies on this company's loans (spellings merged)",
+        "tags": [
+          "Companies"
+        ]
+      }
+    },
+    "/v1/companies/{nmlsId}/breakdowns/zip-codes": {
+      "post": {
+        "operationId": "companyZipCodes",
+        "parameters": [
+          {
+            "description": "Company NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Company NMLS ID",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BreakdownResponse"
+                }
+              }
+            },
+            "description": "Breakdown of the company's loans by zip-codes"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Zip-code volume breakdown across this company's loans",
         "tags": [
           "Companies"
         ]
       }
     },
-    "/v1/companies/{nmlsId}/breakdowns/title-companies": {
-      "post": {
-        "description": "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`.",
-        "operationId": "companyTitleCompanies",
+    "/v1/companies/{nmlsId}/community-lending/benchmark": {
+      "get": {
+        "description": "Percentile rank and peer average of this entity's low- or moderate-income and majority-minority neighborhood shares, against peers producing in its top 12 states by units. `data` is null when the entity has no neighborhood-resolved loans in the period.",
+        "operationId": "companyCommunityLendingBenchmark",
         "parameters": [
           {
-            "description": "Company NMLS ID",
+            "description": "Companie NMLS ID",
             "in": "path",
             "name": "nmlsId",
             "required": true,
             "schema": {
-              "description": "Company NMLS ID",
+              "description": "Companie NMLS ID",
               "type": "string"
             }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/CompanyBreakdownRequest"
-              }
+          },
+          {
+            "description": "Period window (default: last12Months).",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Period window (default: last12Months)."
+                }
+              ]
             }
           }
-        },
+        ],
         "responses": {
           "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/BreakdownResponse"
+                  "$ref": "#/components/schemas/CommunityLendingBenchmarkResponse"
                 }
               }
             },
-            "description": "Breakdown of the entity's loans by title company"
+            "description": "Peer benchmark"
           },
           "400": {
             "content": {
@@ -53431,46 +54065,54 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Title companies on this company's loans (spellings merged)",
+        "summary": "Community Lending peer benchmark (LMI / majority-minority)",
         "tags": [
           "Companies"
         ]
       }
     },
-    "/v1/companies/{nmlsId}/breakdowns/zip-codes": {
-      "post": {
-        "operationId": "companyZipCodes",
+    "/v1/companies/{nmlsId}/community-lending/map": {
+      "get": {
+        "description": "Map points for loans naming this company on the loan document in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.",
+        "operationId": "companyCommunityLendingMap",
         "parameters": [
           {
-            "description": "Company NMLS ID",
+            "description": "Companie NMLS ID",
             "in": "path",
             "name": "nmlsId",
             "required": true,
             "schema": {
-              "description": "Company NMLS ID",
+              "description": "Companie NMLS ID",
               "type": "string"
             }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/CompanyBreakdownRequest"
-              }
+          },
+          {
+            "description": "Period window (default: last12Months).",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Period window (default: last12Months)."
+                }
+              ]
             }
           }
-        },
+        ],
         "responses": {
           "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/BreakdownResponse"
+                  "$ref": "#/components/schemas/CommunityLendingMapResponse"
                 }
               }
             },
-            "description": "Breakdown of the company's loans by zip-codes"
+            "description": "Map feed"
           },
           "400": {
             "content": {
@@ -53533,7 +54175,7 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Zip-code volume breakdown across this company's loans",
+        "summary": "Community Lending map: geocoded loans + per-tract counts",
         "tags": [
           "Companies"
         ]
@@ -70779,7 +71421,7 @@
                 }
               }
             },
-            "description": "Preflight / S3 / DDB / ECS launch failure, or the push-target check could not reach the auth server"
+            "description": "Preflight / S3 / DDB / ECS launch failure, the push-target check could not reach the auth server, or the credit balance could not be read (`billing_unavailable` — retry; a paid delivery is never queued unverified)"
           }
         },
         "summary": "Submit a bulk-delivery job for loans",
@@ -75224,7 +75866,7 @@
                 }
               }
             },
-            "description": "Preflight / S3 / DDB / ECS launch failure, or the push-target check could not reach the auth server"
+            "description": "Preflight / S3 / DDB / ECS launch failure, the push-target check could not reach the auth server, or the credit balance could not be read (`billing_unavailable` — retry; a paid delivery is never queued unverified)"
           }
         },
         "summary": "Submit a bulk-delivery job for originators",
@@ -76988,6 +77630,226 @@
         ]
       }
     },
+    "/v1/originators/{nmlsId}/community-lending/benchmark": {
+      "get": {
+        "description": "Percentile rank and peer average of this entity's low- or moderate-income and majority-minority neighborhood shares, against peers producing in its top 12 states by units. `data` is null when the entity has no neighborhood-resolved loans in the period.",
+        "operationId": "originatorCommunityLendingBenchmark",
+        "parameters": [
+          {
+            "description": "Originator NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Originator NMLS ID",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Period window (default: last12Months).",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Period window (default: last12Months)."
+                }
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommunityLendingBenchmarkResponse"
+                }
+              }
+            },
+            "description": "Peer benchmark"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Community Lending peer benchmark (LMI / majority-minority)",
+        "tags": [
+          "Originators"
+        ]
+      }
+    },
+    "/v1/originators/{nmlsId}/community-lending/map": {
+      "get": {
+        "description": "Map points for this loan officer's loans in the period that resolved to a Census tract, newest first (up to 4,000), plus a per-tract loan count keyed by 11-digit tract GEOID for a choropleth.",
+        "operationId": "originatorCommunityLendingMap",
+        "parameters": [
+          {
+            "description": "Originator NMLS ID",
+            "in": "path",
+            "name": "nmlsId",
+            "required": true,
+            "schema": {
+              "description": "Originator NMLS ID",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Period window (default: last12Months).",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Period window (default: last12Months)."
+                }
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CommunityLendingMapResponse"
+                }
+              }
+            },
+            "description": "Map feed"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Community Lending map: geocoded loans + per-tract counts",
+        "tags": [
+          "Originators"
+        ]
+      }
+    },
     "/v1/originators/{nmlsId}/loans": {
       "post": {
         "operationId": "originatorLoans",
@@ -77842,7 +78704,7 @@
                 }
               }
             },
-            "description": "Preflight / S3 / DDB / ECS launch failure, or the push-target check could not reach the auth server"
+            "description": "Preflight / S3 / DDB / ECS launch failure, the push-target check could not reach the auth server, or the credit balance could not be read (`billing_unavailable` — retry; a paid delivery is never queued unverified)"
           }
         },
         "summary": "Submit a bulk-delivery job for properties",
@@ -78271,7 +79133,7 @@
                 }
               }
             },
-            "description": "Failed to launch task or stage inputs"
+            "description": "Failed to launch task or stage inputs, or the credit balance could not be read (`billing_unavailable`, nothing queued)"
           }
         },
         "summary": "Submit a bulk skip-trace job",