{ "info": { "_postman_id": "a1b2c3d4-license-api-app", "name": "License API", "description": "# License API\n\nREST API over the Real Estate License Database. Aggregated, deduplicated, and\nverified license records for every U.S. state we cover.\n\n## Quick start\n\n1. **Import this collection** into Postman. No separate environment file is\n needed for production usage.\n2. **Set your `apiKey` collection variable** to the raw API key generated from\n the dashboard.\n3. **Smoke test** with `1. Getting started → Health check`. It needs no auth.\n Then run `Verify your API key` to confirm your bearer token is accepted.\n\nThe collection-level `baseUrl` is pre-set to\n`https://app.realestatelicensedatabase.com`.\n\n## Auth\n\nAll `/api/v1/*` endpoints require bearer auth with your raw API key\n(`Authorization: Bearer rel_…`). Public endpoints (`/health`, `/coverage`,\n`/openapi.json`, `/docs`) are unauthenticated.\n\n## Source of truth\n\nThis public production collection is generated from\n`license-api-app/postman/License_API.postman_collection.json` by\n`scripts/sync_postman_to_marketing.py`.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://app.realestatelicensedatabase.com", "type": "default" }, { "key": "apiKey", "value": "", "type": "secret" }, { "key": "licenseState", "value": "CA", "type": "default" }, { "key": "licenseNumber", "value": "00006213", "type": "default" }, { "key": "credentialId", "value": "", "type": "default" }, { "key": "keyId", "value": "", "type": "default" } ], "item": [ { "name": "1. Getting started", "item": [ { "name": "Health check", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/health", "auth": { "type": "noauth" }, "description": "Liveness probe. No auth, no DB query. Returns `{\"status\": \"ok\"}` if the API process is up." }, "response": [] }, { "name": "Verify your API key", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/account", "description": "Returns the account associated with `{{apiKey}}`. Use this to confirm your bearer token is set correctly before running anything else. 401 means the key is missing, wrong, or revoked." }, "response": [] } ], "description": "Smoke-test endpoints to confirm Postman is configured correctly. `Health check` requires no auth; `Verify your API key` proves your `{{apiKey}}` variable is set and active." }, { "name": "2. Search & verify", "item": [ { "name": "Search licensees", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=CA&name=&page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "CA", "description": "Two-letter code (required)" }, { "key": "name", "value": "", "description": "Full or partial name. Matches first/last/business." }, { "key": "status", "value": "", "disabled": true, "description": "e.g. active, inactive, expired" }, { "key": "license_type", "value": "", "disabled": true, "description": "e.g. salesperson, broker, broker_associate" }, { "key": "brokerage", "value": "", "disabled": true, "description": "Fuzzy match on business_name" }, { "key": "city", "value": "", "disabled": true }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "25", "description": "Max 100" } ] }, "description": "Primary search endpoint. Filters cumulatively across `name`/`first_name`/`last_name`, `business_name`/`brokerage`, `status`, `license_type`, and `city`. Use the disabled query params as a menu — enable the ones you need.\n\nResponse shape: `{ data: [...], meta: { total, page, per_page } }`." }, "response": [] }, { "name": "Get licensee by state + license number", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/licensees/{{licenseState}}/{{licenseNumber}}", "description": "Exact lookup by `(state, license_number)`. Returns 404 if not found. Use `Verify a single license` if you'd rather get a `{verified: false}` response than a 404." }, "response": [] }, { "name": "Verify a single license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=CA&license_number=00006213", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "CA" }, { "key": "license_number", "value": "00006213" } ] }, "description": "Boolean verification. Always returns 200 with `{verified, licensee}`. Cheaper than parsing 404s in client code; recommended for verification-style workflows." }, "response": [] }, { "name": "Batch verify licenses", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/api/v1/licensees/batch", "body": { "mode": "raw", "raw": "{\n \"licenses\": [\n {\n \"state\": \"CA\",\n \"license_number\": \"00006213\"\n },\n {\n \"state\": \"TX\",\n \"license_number\": \"9001878\"\n },\n {\n \"state\": \"NY\",\n \"license_number\": \"30AC0961210\"\n },\n {\n \"state\": \"CO\",\n \"license_number\": \"100001191\"\n },\n {\n \"state\": \"CT\",\n \"license_number\": \"RES.0834320\"\n },\n {\n \"state\": \"FL\",\n \"license_number\": \"SL3541481\"\n },\n {\n \"state\": \"GA\",\n \"license_number\": \"103360\"\n },\n {\n \"state\": \"HI\",\n \"license_number\": \"RS.6282.0\"\n },\n {\n \"state\": \"IL\",\n \"license_number\": \"475214266\"\n },\n {\n \"state\": \"MI\",\n \"license_number\": \"6505415932BR0003\"\n },\n {\n \"state\": \"MA\",\n \"license_number\": \"45834-RE-S\"\n },\n {\n \"state\": \"AZ\",\n \"license_number\": \"SA545364000\"\n },\n {\n \"state\": \"AK\",\n \"license_number\": \"137404\"\n },\n {\n \"state\": \"SD\",\n \"license_number\": \"14241\"\n },\n {\n \"state\": \"ND\",\n \"license_number\": \"9550\"\n },\n {\n \"state\": \"OH\",\n \"license_number\": \"SAL.2006001205\"\n },\n {\n \"state\": \"WY\",\n \"license_number\": \"10289\"\n },\n {\n \"state\": \"VA\",\n \"license_number\": \"250860\"\n },\n {\n \"state\": \"NJ\",\n \"license_number\": \"1324634\"\n },\n {\n \"state\": \"OR\",\n \"license_number\": \"201209927\"\n },\n {\n \"state\": \"NV\",\n \"license_number\": \"S.0036002\"\n },\n {\n \"state\": \"WV\",\n \"license_number\": \"WV0013744\"\n },\n {\n \"state\": \"ME\",\n \"license_number\": \"BR923206\"\n },\n {\n \"state\": \"RI\",\n \"license_number\": \"REB.0015562\"\n },\n {\n \"state\": \"UT\",\n \"license_number\": \"5498765-PB00\"\n },\n {\n \"state\": \"KS\",\n \"license_number\": \"00053783\"\n },\n {\n \"state\": \"KY\",\n \"license_number\": \"194476\"\n },\n {\n \"state\": \"IA\",\n \"license_number\": \"S43540000\"\n },\n {\n \"state\": \"MS\",\n \"license_number\": \"S-59080\"\n },\n {\n \"state\": \"TN\",\n \"license_number\": \"285412\"\n },\n {\n \"state\": \"MO\",\n \"license_number\": \"2017001196\"\n },\n {\n \"state\": \"AL\",\n \"license_number\": \"000121511\"\n },\n {\n \"state\": \"MN\",\n \"license_number\": \"20608038\"\n },\n {\n \"state\": \"MD\",\n \"license_number\": \"625389\"\n },\n {\n \"state\": \"NC\",\n \"license_number\": \"112736\"\n },\n {\n \"state\": \"WI\",\n \"license_number\": \"60000 - 90\"\n },\n {\n \"state\": \"NM\",\n \"license_number\": \"0183981\"\n },\n {\n \"state\": \"OK\",\n \"license_number\": \"140797\"\n },\n {\n \"state\": \"LA\",\n \"license_number\": \"09189\"\n },\n {\n \"state\": \"AR\",\n \"license_number\": \"SA00070189\"\n },\n {\n \"state\": \"NH\",\n \"license_number\": \"049285\"\n },\n {\n \"state\": \"ID\",\n \"license_number\": \"SP31021\"\n },\n {\n \"state\": \"IN\",\n \"license_number\": \"RB14037612\"\n },\n {\n \"state\": \"MT\",\n \"license_number\": \"RRE-RBS-LIC-1504\"\n },\n {\n \"state\": \"SC\",\n \"license_number\": \"REL.62282\"\n }\n ]\n}" }, "description": "Verify many licenses in a single request. Returns one entry per input, in the same order, each with `{state, license_number, verified, licensee}`. There is no per-account size limit yet — be reasonable (≤ 1000 per call)." }, "response": [] }, { "name": "Search licenses (alternate /licenses/search)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=CA&page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "CA" }, { "key": "license_number", "value": "", "disabled": true }, { "key": "first_name", "value": "", "disabled": true }, { "key": "last_name", "value": "", "disabled": true }, { "key": "business_name", "value": "", "disabled": true }, { "key": "license_type", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "city", "value": "", "disabled": true }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "25" } ] }, "description": "Lower-level search that returns flat license rows (id, license_number, names, type, status, city, expiration). Same filters as `Search licensees` but no joined affiliation data. Use this when you only need the license-row payload." }, "response": [] }, { "name": "Get license by state + number", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/licenses/{{licenseState}}/{{licenseNumber}}", "description": "Same as `Get licensee by state + license number` but returns the flat `license` row only. Returns `{data: null}` instead of 404 when the row doesn't exist." }, "response": [] }, { "name": "License type counts (all states)", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/licenses/license-type-counts", "description": "Per-state breakdown of license-type populations, e.g. how many active brokers vs salespersons in each jurisdiction. Powered by a materialized view; cheap to call." }, "response": [] }, { "name": "License type counts (single state)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/license-type-counts?state=TX", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "license-type-counts" ], "query": [ { "key": "state", "value": "TX", "description": "Optional 2-letter filter" } ] }, "description": "Same shape as the all-states version, scoped to one state." }, "response": [] }, { "name": "Changes feed (stub)", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/licensees/changes", "description": "**Reserved.** Returns an empty array today. Will eventually stream incremental change events for downstream sync. Do not build against this yet." }, "response": [] } ], "description": "Canonical state-agnostic endpoints. Pass a 2-letter `state` and the API routes to the right per-state adapter under the hood. These are the endpoints integrators should call from production code; the per-state examples in folder 5 are for exploration only." }, { "name": "3. Affiliations & supervisors", "item": [ { "name": "Affiliation history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/{{licenseState}}/{{licenseNumber}}/affiliations?include_inactive=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "{{licenseState}}", "{{licenseNumber}}", "affiliations" ], "query": [ { "key": "as_of", "value": "", "disabled": true, "description": "ISO date; reconstructs history at that point" }, { "key": "include_inactive", "value": "false" }, { "key": "affiliate_role", "value": "broker_associate_affiliate", "disabled": true, "description": "e.g. salesperson_affiliate or broker_associate_affiliate" }, { "key": "relationship_type", "value": "ca_dre.broker_associate_affiliation", "disabled": true, "description": "Optional relationship-type filter" } ] }, "description": "Full supervisor history for one licensee (open + closed rows). Set `include_inactive=true` to include closed rows. `affiliate_role` and `relationship_type` are optional filters; use them for CA broker-associates (see California folder for an example with the filters enabled)." }, "response": [ { "name": "CA broker-associate history example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/{{licenseState}}/{{licenseNumber}}/affiliations?include_inactive=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "{{licenseState}}", "{{licenseNumber}}", "affiliations" ], "query": [ { "key": "include_inactive", "value": "false" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"supervisor_license_credential_id\": \"uuid\",\n \"supervisor_license_number\": \"01751052\",\n \"supervisor_full_name\": \"Tal Bader\",\n \"affiliate_role\": \"broker_associate_affiliate\",\n \"relationship_type\": \"ca_dre.broker_associate_affiliation\",\n \"effective_from\": \"2019-02-21\",\n \"effective_to\": null,\n \"status\": \"active\"\n }\n ]\n}" } ] }, { "name": "Current supervisor (legacy single)", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/licensees/{{licenseState}}/{{licenseNumber}}/supervisor", "description": "Returns the single most recent open supervisor for the licensee. **Legacy.** Prefer `Current supervisors (plural)` for any new integration; California broker-associates can have multiple open supervisors at once and this endpoint will only return one of them. Returns 404 when no supervisor is on file." }, "response": [] }, { "name": "Current supervisors (plural — recommended)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/{{licenseState}}/{{licenseNumber}}/supervisors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "{{licenseState}}", "{{licenseNumber}}", "supervisors" ], "query": [ { "key": "affiliate_role", "value": "broker_associate_affiliate", "disabled": true, "description": "Optional filter" }, { "key": "relationship_type", "value": "ca_dre.broker_associate_affiliation", "disabled": true, "description": "Optional filter" } ] }, "description": "Returns *all* currently open supervisor relationships for the licensee. Returns an empty `data: []` (not 404) when none are on file. This is the endpoint to call from production code." }, "response": [] }, { "name": "List affiliates (supervising broker)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/{{licenseState}}/{{licenseNumber}}/affiliates?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "{{licenseState}}", "{{licenseNumber}}", "affiliates" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "25", "description": "Max 100" }, { "key": "affiliate_role", "value": "broker_associate_affiliate", "disabled": true, "description": "Optional filter" }, { "key": "relationship_type", "value": "ca_dre.broker_associate_affiliation", "disabled": true, "description": "Optional filter" } ] }, "description": "Inverse of supervisors: given a supervising broker, list the licensees they currently supervise. Pages 25 at a time by default. Useful for brokerage roster pages." }, "response": [] }, { "name": "Supervisor hierarchy by credential UUID", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/license-credentials/{{credentialId}}/hierarchy", "description": "Recursively walks supervision chains starting from a license-credential UUID. Use the `id` field returned by `Search licensees` (each licensee includes its license credential UUID). Returns the chain as an ordered list." }, "response": [] } ], "description": "Broker → salesperson supervision and affiliation history. California is the only jurisdiction with rich data today (DRE publishes a bipartite licensee/affiliation feed). Other states return an empty list rather than 404, so a frontend can render \"no affiliations on file\" uniformly.\n\n**Two flavors of \"current supervisor\":**\n- `/supervisor` (singular) — legacy view, returns the single most recent open relationship. Use for backward compat only.\n- `/supervisors` (plural) — recommended. Returns *all* currently open supervisor relationships, important for CA broker-associates who can be supervised by multiple responsible brokers simultaneously." }, { "name": "4. Coverage & reference", "item": [ { "name": "Coverage (programmatic)", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/coverage", "auth": { "type": "noauth" }, "description": "Per-state coverage rollup with status, refresh frequency, total + active record counts, and `last_updated`. Public; safe to embed in marketing pages. This is the canonical coverage endpoint." }, "response": [] }, { "name": "List supported states", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/states", "description": "Every state row known to the system, with `is_active` indicating whether it currently has loaded data. Useful for populating dropdowns in your UI." }, "response": [] }, { "name": "List sources", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/sources", "description": "Per-state source rows (id, state abbreviation, status). Low-level endpoint; prefer `Coverage` for richer rollups." }, "response": [] }, { "name": "Sources coverage (legacy shape)", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/sources/coverage", "description": "Older coverage shape kept for backward compatibility. New code should use `/api/v1/coverage` instead." }, "response": [] } ], "description": "Programmatic coverage metadata. Use these when surfacing \"what data do you have?\" in your own UI. The `Coverage (programmatic)` endpoint is intentionally unauthenticated so it can be used in marketing pages." }, { "name": "5. States", "item": [ { "name": "California (CA)", "item": [ { "name": "CA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=CA&name=nguyen&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "CA" }, { "key": "name", "value": "nguyen" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search California licensees with a known surname (`nguyen`)." }, "response": [] }, { "name": "CA — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=CA&license_number=00006213", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "CA" }, { "key": "license_number", "value": "00006213" } ] }, "description": "Verify a known-good California license number (`00006213`)." }, "response": [] }, { "name": "CA — Affiliation history (broker-associate)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/CA/{{licenseNumber}}/affiliations?include_inactive=false&affiliate_role=broker_associate_affiliate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "CA", "{{licenseNumber}}", "affiliations" ], "query": [ { "key": "include_inactive", "value": "false" }, { "key": "affiliate_role", "value": "broker_associate_affiliate", "description": "CA-specific filter" } ] }, "description": "California broker-associate affiliation history. Set `{{licenseNumber}}` to a CA broker-associate license (e.g. `01952700`) before running." }, "response": [] }, { "name": "CA — Current supervisors (broker-associate)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/CA/{{licenseNumber}}/supervisors?affiliate_role=broker_associate_affiliate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "CA", "{{licenseNumber}}", "supervisors" ], "query": [ { "key": "affiliate_role", "value": "broker_associate_affiliate" } ] }, "description": "All currently-open responsible brokers for a CA broker-associate. Often returns multiple rows." }, "response": [] }, { "name": "CA — List affiliates (supervising broker)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/CA/{{licenseNumber}}/affiliates?page=1&per_page=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "CA", "{{licenseNumber}}", "affiliates" ], "query": [ { "key": "page", "value": "1" }, { "key": "per_page", "value": "25" }, { "key": "affiliate_role", "value": "broker_associate_affiliate", "disabled": true, "description": "Optional filter" } ] }, "description": "Salespersons + broker-associates currently supervised by the broker at `{{licenseNumber}}`. Set `{{licenseNumber}}` to a supervising broker (e.g. `01751052`) before running." }, "response": [] } ], "description": "Realistic example requests for **California (CA)**.\n\nCalifornia broker-associate relationships are exposed through the affiliation endpoints with `affiliate_role=broker_associate_affiliate` and `relationship_type=ca_dre.broker_associate_affiliation`." }, { "name": "Texas (TX)", "item": [ { "name": "TX — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=TX&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "TX" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Texas licensees with a known surname (`smith`)." }, "response": [] }, { "name": "TX — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=TX&first_name=John&last_name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "TX" }, { "key": "first_name", "value": "John" }, { "key": "last_name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "TX — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=TX&license_number=9001878", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "TX" }, { "key": "license_number", "value": "9001878" } ] }, "description": "Verify a known-good Texas license number (`9001878`)." }, "response": [] } ], "description": "Realistic example requests for **Texas (TX)**." }, { "name": "New York (NY)", "item": [ { "name": "NY — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NY&name=johnson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NY" }, { "key": "name", "value": "johnson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search New York licensees with a known surname (`johnson`)." }, "response": [] }, { "name": "NY — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NY&brokerage=coldwell banker&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NY" }, { "key": "brokerage", "value": "coldwell banker" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known New York brokerage (`coldwell banker`)." }, "response": [] }, { "name": "NY — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=NY&first_name=Beth&last_name=Acocella&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "NY" }, { "key": "first_name", "value": "Beth" }, { "key": "last_name", "value": "Acocella" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "NY — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=NY&license_number=30AC0961210", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "NY" }, { "key": "license_number", "value": "30AC0961210" } ] }, "description": "Verify a known-good New York license number (`30AC0961210`)." }, "response": [] }, { "name": "NY — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=NY&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "NY" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for New York. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **New York (NY)**." }, { "name": "Colorado (CO)", "item": [ { "name": "CO — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=CO&name=martinez&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "CO" }, { "key": "name", "value": "martinez" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Colorado licensees with a known surname (`martinez`)." }, "response": [] }, { "name": "CO — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=CO&brokerage=keller williams&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "CO" }, { "key": "brokerage", "value": "keller williams" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Colorado brokerage (`keller williams`)." }, "response": [] }, { "name": "CO — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=CO&license_number=100001191", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "CO" }, { "key": "license_number", "value": "100001191" } ] }, "description": "Verify a known-good Colorado license number (`100001191`)." }, "response": [] }, { "name": "CO — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=CO&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "CO" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Colorado. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Colorado (CO)**." }, { "name": "Delaware (DE)", "item": [ { "name": "DE — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=DE&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "DE" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Delaware licensees with a known surname (`smith`)." }, "response": [] } ], "description": "Realistic example requests for **Delaware (DE)**.\n\nDelaware licensee-only data from the Socrata open-data export. Pick a license number from a Search result to use Verify." }, { "name": "Pennsylvania (PA)", "item": [ { "name": "PA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=PA&name=public&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "PA" }, { "key": "name", "value": "public" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Pennsylvania licensees with a known surname (`public`)." }, "response": [] }, { "name": "PA — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=PA&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "PA" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Pennsylvania. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Pennsylvania (PA)**.\n\nVerify examples are intentionally left blank for PA — pick one from the Search result first." }, { "name": "Connecticut (CT)", "item": [ { "name": "CT — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=CT&name=saucier&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "CT" }, { "key": "name", "value": "saucier" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Connecticut licensees with a known surname (`saucier`)." }, "response": [] }, { "name": "CT — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=CT&brokerage=william raveis&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "CT" }, { "key": "brokerage", "value": "william raveis" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Connecticut brokerage (`william raveis`)." }, "response": [] }, { "name": "CT — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=CT&license_number=RES.0834320", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "CT" }, { "key": "license_number", "value": "RES.0834320" } ] }, "description": "Verify a known-good Connecticut license number (`RES.0834320`)." }, "response": [] }, { "name": "CT — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=CT&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "CT" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Connecticut. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Connecticut (CT)**." }, { "name": "Florida (FL)", "item": [ { "name": "FL — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=FL&name=aaron&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "FL" }, { "key": "name", "value": "aaron" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Florida licensees with a known surname (`aaron`)." }, "response": [] }, { "name": "FL — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=FL&brokerage=global ventures&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "FL" }, { "key": "brokerage", "value": "global ventures" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Florida brokerage (`global ventures`)." }, "response": [] }, { "name": "FL — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=FL&license_number=SL3541481", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "FL" }, { "key": "license_number", "value": "SL3541481" } ] }, "description": "Verify a known-good Florida license number (`SL3541481`)." }, "response": [] } ], "description": "Realistic example requests for **Florida (FL)**." }, { "name": "Georgia (GA)", "item": [ { "name": "GA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=GA&name=TULLER&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "GA" }, { "key": "name", "value": "TULLER" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Georgia licensees with a known surname (`TULLER`)." }, "response": [] }, { "name": "GA — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=GA&brokerage=Sunbelco&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "GA" }, { "key": "brokerage", "value": "Sunbelco" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Georgia brokerage (`Sunbelco`)." }, "response": [] }, { "name": "GA — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=GA&license_number=103360", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "GA" }, { "key": "license_number", "value": "103360" } ] }, "description": "Verify a known-good Georgia license number (`103360`)." }, "response": [] }, { "name": "GA — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=GA&license_type=broker_principal&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "GA" }, { "key": "license_type", "value": "broker_principal" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Georgia. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Georgia (GA)**.\n\nGeorgia Real Estate Commission and Appraisers Board monthly Real Estate Database Order. Operator-delivered active and inactive person CSVs are normalized into `ga_grec.real_estate_v1`. Licensee-only first cut; company and qualifying broker fields are preserved in the canonical CSV for future affiliation work." }, { "name": "Hawaii (HI)", "item": [ { "name": "HI — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=HI&name=Faulkner&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "HI" }, { "key": "name", "value": "Faulkner" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Hawaii licensees with a known surname (`Faulkner`)." }, "response": [] }, { "name": "HI — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=HI&brokerage=Hawaii Life&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "HI" }, { "key": "brokerage", "value": "Hawaii Life" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Hawaii brokerage (`Hawaii Life`)." }, "response": [] }, { "name": "HI — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=HI&license_number=RS.6282.0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "HI" }, { "key": "license_number", "value": "RS.6282.0" } ] }, "description": "Verify a known-good Hawaii license number (`RS.6282.0`)." }, "response": [] }, { "name": "HI — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=HI&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "HI" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Hawaii. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Hawaii (HI)**.\n\nHawaii DCCA PVL List Builder package for Real Estate Commission board 900. License numbers are composed from the PVL relationship key as `..`, and employer references are normalized into `hi_dcca.employer_affiliation` edges." }, { "name": "Illinois (IL)", "item": [ { "name": "IL — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=IL&name=payes&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "IL" }, { "key": "name", "value": "payes" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Illinois licensees with a known surname (`payes`)." }, "response": [] }, { "name": "IL — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=IL&brokerage=realty&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "IL" }, { "key": "brokerage", "value": "realty" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Illinois brokerage (`realty`)." }, "response": [] }, { "name": "IL — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=IL&license_number=475214266", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "IL" }, { "key": "license_number", "value": "475214266" } ] }, "description": "Verify a known-good Illinois license number (`475214266`)." }, "response": [] } ], "description": "Realistic example requests for **Illinois (IL)**." }, { "name": "Michigan (MI)", "item": [ { "name": "MI — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MI&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MI" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Michigan licensees with a known surname (`smith`)." }, "response": [] }, { "name": "MI — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MI&brokerage=real estate&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MI" }, { "key": "brokerage", "value": "real estate" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Michigan brokerage (`real estate`)." }, "response": [] }, { "name": "MI — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MI&license_number=6505415932BR0003", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MI" }, { "key": "license_number", "value": "6505415932BR0003" } ] }, "description": "Verify a known-good Michigan license number (`6505415932BR0003`)." }, "response": [] } ], "description": "Realistic example requests for **Michigan (MI)**." }, { "name": "Massachusetts (MA)", "item": [ { "name": "MA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MA&name=strate&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MA" }, { "key": "name", "value": "strate" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Massachusetts licensees with a known surname (`strate`)." }, "response": [] }, { "name": "MA — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MA&brokerage=ACME REALTY INC&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MA" }, { "key": "brokerage", "value": "ACME REALTY INC" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Massachusetts brokerage (`ACME REALTY INC`)." }, "response": [] }, { "name": "MA — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MA&license_number=45834-RE-S", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MA" }, { "key": "license_number", "value": "45834-RE-S" } ] }, "description": "Verify a known-good Massachusetts license number (`45834-RE-S`)." }, "response": [] }, { "name": "MA — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=MA&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "MA" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Massachusetts. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Massachusetts (MA)**." }, { "name": "Arizona (AZ)", "item": [ { "name": "AZ — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=AZ&name=carneal&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "AZ" }, { "key": "name", "value": "carneal" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Arizona licensees with a known surname (`carneal`)." }, "response": [] }, { "name": "AZ — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=AZ&brokerage=abrams&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "AZ" }, { "key": "brokerage", "value": "abrams" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Arizona brokerage (`abrams`)." }, "response": [] }, { "name": "AZ — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=AZ&license_number=SA545364000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "AZ" }, { "key": "license_number", "value": "SA545364000" } ] }, "description": "Verify a known-good Arizona license number (`SA545364000`)." }, "response": [] } ], "description": "Realistic example requests for **Arizona (AZ)**." }, { "name": "Alaska (AK)", "item": [ { "name": "AK — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=AK&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "AK" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Alaska licensees with a known surname (`smith`)." }, "response": [] }, { "name": "AK — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=AK&brokerage=real estate&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "AK" }, { "key": "brokerage", "value": "real estate" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Alaska brokerage (`real estate`)." }, "response": [] }, { "name": "AK — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=AK&license_number=137404", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "AK" }, { "key": "license_number", "value": "137404" } ] }, "description": "Verify a known-good Alaska license number (`137404`)." }, "response": [] }, { "name": "AK — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=AK&license_type=associate_broker&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "AK" }, { "key": "license_type", "value": "associate_broker" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Alaska. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Alaska (AK)**.\n\nAlaska CBPL bulk professional license download filtered to Real Estate (``ak_cbpl.real_estate_v1``). License numbers are numeric or prefixed (e.g. ``RECA16251``)." }, { "name": "Vermont (VT)", "item": [ { "name": "VT — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=VT&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "VT" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Vermont licensees with a known surname (`smith`)." }, "response": [] } ], "description": "Realistic example requests for **Vermont (VT)**.\n\nVermont OPR uses a Pega-driven roster export; license numbers are alphanumeric (e.g. ``030.0123334-PRSP``). Pick a real one from the Search response before running Verify." }, { "name": "Puerto Rico (PR)", "item": [ { "name": "PR — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=PR&name=rodriguez&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "PR" }, { "key": "name", "value": "rodriguez" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Puerto Rico licensees with a known surname (`rodriguez`)." }, "response": [] } ], "description": "Realistic example requests for **Puerto Rico (PR)**.\n\nPuerto Rico license numbers are sequential integers issued by PCS (BIENES RAICES board). Pick one from the Search response before running Verify." }, { "name": "South Dakota (SD)", "item": [ { "name": "SD — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=SD&name=aberson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "SD" }, { "key": "name", "value": "aberson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search South Dakota licensees with a known surname (`aberson`)." }, "response": [] }, { "name": "SD — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=SD&brokerage=green acre&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "SD" }, { "key": "brokerage", "value": "green acre" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known South Dakota brokerage (`green acre`)." }, "response": [] }, { "name": "SD — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=SD&license_number=14241", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "SD" }, { "key": "license_number", "value": "14241" } ] }, "description": "Verify a known-good South Dakota license number (`14241`)." }, "response": [] }, { "name": "SD — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=SD&license_type=broker&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "SD" }, { "key": "license_type", "value": "broker" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for South Dakota. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **South Dakota (SD)**.\n\nSouth Dakota SDREC is harvested from the public Licensee Roster for Broker, Broker Associate, Salesperson, and Res. Rental Agent license types. Additional firm rows share the same license number and are preserved in the audit trail." }, { "name": "North Dakota (ND)", "item": [ { "name": "ND — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=ND&name=aadnes&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "ND" }, { "key": "name", "value": "aadnes" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search North Dakota licensees with a known surname (`aadnes`)." }, "response": [] }, { "name": "ND — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=ND&brokerage=better homes&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "ND" }, { "key": "brokerage", "value": "better homes" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known North Dakota brokerage (`better homes`)." }, "response": [] }, { "name": "ND — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=ND&license_number=9550", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "ND" }, { "key": "license_number", "value": "9550" } ] }, "description": "Verify a known-good North Dakota license number (`9550`)." }, "response": [] }, { "name": "ND — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=ND&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "ND" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for North Dakota. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **North Dakota (ND)**.\n\nNorth Dakota REC is harvested from the public Licensee Directory for Broker, Broker Associate, and Salesperson rows. The scraper uses the directory's address-state search shortcut plus per-row detail pages for status and date fields." }, { "name": "Ohio (OH)", "item": [ { "name": "OH — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=OH&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "OH" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Ohio licensees with a known surname (`smith`)." }, "response": [] }, { "name": "OH — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=OH&brokerage=sibcy cline&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "OH" }, { "key": "brokerage", "value": "sibcy cline" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Ohio brokerage (`sibcy cline`)." }, "response": [] }, { "name": "OH — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=OH&first_name=Kathie&last_name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "OH" }, { "key": "first_name", "value": "Kathie" }, { "key": "last_name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "OH — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=OH&license_number=SAL.2006001205", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "OH" }, { "key": "license_number", "value": "SAL.2006001205" } ] }, "description": "Verify a known-good Ohio license number (`SAL.2006001205`)." }, "response": [] }, { "name": "OH — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=OH&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "OH" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Ohio. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Ohio (OH)**.\n\nOhio REPL is an affiliation-shape bulk download: the state publishes `repl_LicenseLookUpwithAffiliations.xlsx` daily. Each salesperson row carries the affiliated brokerage's license number in `primary_license_number`, which the ingester maps to an `oh_repl.salesperson_broker_affiliation` relationship. Verify examples pin to `SAL.2006001205` (Kathie L Smith, affiliated with Sibcy Cline, Inc.)." }, { "name": "Wyoming (WY)", "item": [ { "name": "WY — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=WY&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "WY" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Wyoming licensees with a known surname (`smith`)." }, "response": [] }, { "name": "WY — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=WY&brokerage=keller williams&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "WY" }, { "key": "brokerage", "value": "keller williams" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Wyoming brokerage (`keller williams`)." }, "response": [] }, { "name": "WY — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=WY&first_name=Amy&last_name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "WY" }, { "key": "first_name", "value": "Amy" }, { "key": "last_name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "WY — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=WY&license_number=10289", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "WY" }, { "key": "license_number", "value": "10289" } ] }, "description": "Verify a known-good Wyoming license number (`10289`)." }, "response": [] }, { "name": "WY — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=WY&license_type=responsible_broker&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "WY" }, { "key": "license_type", "value": "responsible_broker" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Wyoming. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Wyoming (WY)**.\n\nWyoming WYREC is harvested from the public verify-license API for Real Estate Salesperson, Associate Broker, and Responsible Broker licenses. Relationship rows include the related firm license number when WYREC exposes it." }, { "name": "Virginia (VA)", "item": [ { "name": "VA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=VA&name=brown&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "VA" }, { "key": "name", "value": "brown" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Virginia licensees with a known surname (`brown`)." }, "response": [] }, { "name": "VA — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=VA&first_name=Dalh&last_name=Brown&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "VA" }, { "key": "first_name", "value": "Dalh" }, { "key": "last_name", "value": "Brown" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "VA — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=VA&license_number=250860", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "VA" }, { "key": "license_number", "value": "250860" } ] }, "description": "Verify a known-good Virginia license number (`250860`)." }, "response": [] }, { "name": "VA — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=VA&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "VA" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Virginia. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Virginia (VA)**.\n\nVirginia DPOR publishes free tab-delimited regulant lists for the Real Estate Board, covering salespersons, principal brokers, associate brokers, and sole proprietors (active + inactive). Eight files are merged into a single CSV by the scraper." }, { "name": "New Jersey (NJ)", "item": [ { "name": "NJ — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NJ&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NJ" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search New Jersey licensees with a known surname (`smith`)." }, "response": [] }, { "name": "NJ — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NJ&brokerage=keller williams&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NJ" }, { "key": "brokerage", "value": "keller williams" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known New Jersey brokerage (`keller williams`)." }, "response": [] }, { "name": "NJ — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=NJ&first_name=William&last_name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "NJ" }, { "key": "first_name", "value": "William" }, { "key": "last_name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "NJ — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=NJ&license_number=1324634", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "NJ" }, { "key": "license_number", "value": "1324634" } ] }, "description": "Verify a known-good New Jersey license number (`1324634`)." }, "response": [] }, { "name": "NJ — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=NJ&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "NJ" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for New Jersey. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **New Jersey (NJ)**.\n\nNew Jersey NJREC is harvested from the NJ REALTORS public license search wrapper at https://www.njrealtor.com/license, which fronts the NJREC license database. Each row pairs an actively-licensed individual (Salesperson, Broker-Salesperson, Broker of Record) with their brokerage office license number, producing an `nj_njrec.office_affiliation` relationship per row. The DOBI portal is fronted by Imperva and not used." }, { "name": "Oregon (OR)", "item": [ { "name": "OR — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=OR&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "OR" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Oregon licensees with a known surname (`smith`)." }, "response": [] }, { "name": "OR — Search legacy (first/last name)", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/search?state=OR&first_name=Alex&last_name=Aaronson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "search" ], "query": [ { "key": "state", "value": "OR" }, { "key": "first_name", "value": "Alex" }, { "key": "last_name", "value": "Aaronson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Legacy `/licensees/search` endpoint that takes `first_name`+`last_name` separately. New code should use `/licensees?name=…` (folder 2)." }, "response": [] }, { "name": "OR — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=OR&license_number=201209927", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "OR" }, { "key": "license_number", "value": "201209927" } ] }, "description": "Verify a known-good Oregon license number (`201209927`)." }, "response": [] }, { "name": "OR — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=OR&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "OR" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Oregon. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Oregon (OR)**.\n\nOregon Real Estate Agency (OREA) publishes free downloadable rosters through a MicroPact eLicense portal. The Active Individuals roster covers brokers (salesperson-equivalent), principal brokers, and property managers, each linked to their Registered Business Name (brokerage)." }, { "name": "Nevada (NV)", "item": [ { "name": "NV — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NV&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NV" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Nevada licensees with a known surname (`smith`)." }, "response": [] }, { "name": "NV — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=NV&license_number=S.0036002", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "NV" }, { "key": "license_number", "value": "S.0036002" } ] }, "description": "Verify a known-good Nevada license number (`S.0036002`)." }, "response": [] }, { "name": "NV — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=NV&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "NV" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Nevada. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Nevada (NV)**.\n\nNevada Real Estate Division (NRED) publishes monthly active licensee lists as XLSX files covering brokers, broker-salespersons, salespersons, business brokers, and property managers. The scraper merges all five files into a single CSV." }, { "name": "West Virginia (WV)", "item": [ { "name": "WV — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=WV&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "WV" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search West Virginia licensees with a known surname (`smith`)." }, "response": [] }, { "name": "WV — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=WV&license_number=WV0013744", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "WV" }, { "key": "license_number", "value": "WV0013744" } ] }, "description": "Verify a known-good West Virginia license number (`WV0013744`)." }, "response": [] } ], "description": "Realistic example requests for **West Virginia (WV)**.\n\nWest Virginia Real Estate Commission (WVREC) publishes active licensee rosters as XLSX files covering brokers, associate brokers, and salespersons. The scraper merges all three files into a single CSV." }, { "name": "Maine (ME)", "item": [ { "name": "ME — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=ME&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "ME" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Maine licensees with a known surname (`smith`)." }, "response": [] }, { "name": "ME — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=ME&license_number=BR923206", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "ME" }, { "key": "license_number", "value": "BR923206" } ] }, "description": "Verify a known-good Maine license number (`BR923206`)." }, "response": [] }, { "name": "ME — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=ME&name=portland&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "ME" }, { "key": "name", "value": "portland" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Maine. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Maine (ME)**.\n\nMaine Office of Professional and Occupational Regulation publishes licensee data through its ALMS system. The scraper exports all Real Estate Commission individuals and companies, merging them into a single CSV." }, { "name": "Rhode Island (RI)", "item": [ { "name": "RI — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=RI&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "RI" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Rhode Island licensees with a known surname (`smith`)." }, "response": [] }, { "name": "RI — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=RI&license_number=REB.0015562", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "RI" }, { "key": "license_number", "value": "REB.0015562" } ] }, "description": "Verify a known-good Rhode Island license number (`REB.0015562`)." }, "response": [] } ], "description": "Realistic example requests for **Rhode Island (RI)**.\n\nRhode Island Department of Business Regulation publishes a real estate roster via a Tyler Technologies portal. The roster covers active brokers, corporations, school permits, and inter-state land trusts." }, { "name": "Utah (UT)", "item": [ { "name": "UT — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=UT&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "UT" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Utah licensees with a known surname (`smith`)." }, "response": [] }, { "name": "UT — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=UT&license_number=5498765-PB00", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "UT" }, { "key": "license_number", "value": "5498765-PB00" } ] }, "description": "Verify a known-good Utah license number (`5498765-PB00`)." }, "response": [] } ], "description": "Realistic example requests for **Utah (UT)**.\n\nUtah Division of Real Estate publishes free summary CSV downloads including all sales agents, brokers, real estate companies, branch offices, property management companies, and CE/prelicensing instructors." }, { "name": "Kansas (KS)", "item": [ { "name": "KS — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=KS&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "KS" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Kansas licensees with a known surname (`smith`)." }, "response": [] }, { "name": "KS — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=KS&license_number=00053783", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "KS" }, { "key": "license_number", "value": "00053783" } ] }, "description": "Verify a known-good Kansas license number (`00053783`)." }, "response": [] } ], "description": "Realistic example requests for **Kansas (KS)**.\n\nKansas Real Estate Commission publishes a monthly Licensee Data Report as a free CSV download. Includes all salespersons and brokers with company affiliation and supervising broker data." }, { "name": "Kentucky (KY)", "item": [ { "name": "KY — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=KY&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "KY" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Kentucky licensees with a known surname (`smith`)." }, "response": [] }, { "name": "KY — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=KY&brokerage=realtors&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "KY" }, { "key": "brokerage", "value": "realtors" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Kentucky brokerage (`realtors`)." }, "response": [] }, { "name": "KY — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=KY&license_number=194476", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "KY" }, { "key": "license_number", "value": "194476" } ] }, "description": "Verify a known-good Kentucky license number (`194476`)." }, "response": [] } ], "description": "Realistic example requests for **Kentucky (KY)**.\n\nKentucky Real Estate Commission via the KY Office of Occupations and Professions shared verification portal (`oop.ky.gov`). Weekly scraper harvest of the KREC active individual roster plus per-licensee firm affiliations (Sales Associates, Brokers, and Registered Firm Branches with principal-broker metadata)." }, { "name": "Iowa (IA)", "item": [ { "name": "IA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=IA&name=brown&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "IA" }, { "key": "name", "value": "brown" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Iowa licensees with a known surname (`brown`)." }, "response": [] }, { "name": "IA — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=IA&brokerage=bloomfield&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "IA" }, { "key": "brokerage", "value": "bloomfield" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Iowa brokerage (`bloomfield`)." }, "response": [] }, { "name": "IA — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=IA&license_number=S43540000", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "IA" }, { "key": "license_number", "value": "S43540000" } ] }, "description": "Verify a known-good Iowa license number (`S43540000`)." }, "response": [] }, { "name": "IA — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=IA&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "IA" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Iowa. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Iowa (IA)**.\n\nIowa PLB Real Estate Commission rows come from the LicensedInIowa portal CSV export. The source exposes firm names in the roster, but firm license numbers require per-record detail enrichment and are not modeled as affiliation edges." }, { "name": "Mississippi (MS)", "item": [ { "name": "MS — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MS&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MS" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Mississippi licensees with a known surname (`smith`)." }, "response": [] }, { "name": "MS — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MS&license_number=S-59080", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MS" }, { "key": "license_number", "value": "S-59080" } ] }, "description": "Verify a known-good Mississippi license number (`S-59080`)." }, "response": [] }, { "name": "MS — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=MS&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "MS" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Mississippi. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Mississippi (MS)**.\n\nMississippi Real Estate Commission active broker and salesperson rows are harvested from the public WebForms search. The grid supports licensee-only coverage; detail-page employer enrichment can be added later." }, { "name": "Tennessee (TN)", "item": [ { "name": "TN — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=TN&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "TN" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Tennessee licensees with a known surname (`smith`)." }, "response": [] }, { "name": "TN — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=TN&license_number=285412", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "TN" }, { "key": "license_number", "value": "285412" } ] }, "description": "Verify a known-good Tennessee license number (`285412`)." }, "response": [] } ], "description": "Realistic example requests for **Tennessee (TN)**.\n\nTennessee Real Estate Commission licensees accessed via MicroPact/Entellitrak public API. Covers affiliate brokers, brokers, timeshare salespersons, firms, VLS designated agents, and acquisition agents." }, { "name": "Missouri (MO)", "item": [ { "name": "MO — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MO&name=gray&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MO" }, { "key": "name", "value": "gray" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Missouri licensees with a known surname (`gray`)." }, "response": [] }, { "name": "MO — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MO&license_number=2017001196", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MO" }, { "key": "license_number", "value": "2017001196" } ] }, "description": "Verify a known-good Missouri license number (`2017001196`)." }, "response": [] } ], "description": "Realistic example requests for **Missouri (MO)**.\n\nMissouri Real Estate Commission licensees from MOPRO Downloadable Listings. Covers active individual licensees, brokerage entities, professional affiliations, and designated-broker relationships." }, { "name": "Alabama (AL)", "item": [ { "name": "AL — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=AL&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "AL" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Alabama licensees with a known surname (`smith`)." }, "response": [] }, { "name": "AL — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=AL&license_number=000121511", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "AL" }, { "key": "license_number", "value": "000121511" } ] }, "description": "Verify a known-good Alabama license number (`000121511`)." }, "response": [] } ], "description": "Realistic example requests for **Alabama (AL)**.\n\nAlabama Real Estate Commission paid monthly list purchase. Company/Personnel and Licensee lists merged to cover salespersons, brokers, companies, and branch offices with company affiliation data." }, { "name": "Minnesota (MN)", "item": [ { "name": "MN — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MN&name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MN" }, { "key": "name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Minnesota licensees with a known surname (`Smith`)." }, "response": [] }, { "name": "MN — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MN&license_number=20608038", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MN" }, { "key": "license_number", "value": "20608038" } ] }, "description": "Verify a known-good Minnesota license number (`20608038`)." }, "response": [] } ], "description": "Realistic example requests for **Minnesota (MN)**.\n\nMinnesota Department of Commerce PULSE Portal (Vertafore/Sircon). Weekly scraper harvest covering resident and non-resident real estate salespersons and brokers." }, { "name": "Maryland (MD)", "item": [ { "name": "MD — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MD&name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MD" }, { "key": "name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Maryland licensees with a known surname (`Smith`)." }, "response": [] }, { "name": "MD — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MD&license_number=625389", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MD" }, { "key": "license_number", "value": "625389" } ] }, "description": "Verify a known-good Maryland license number (`625389`)." }, "response": [] } ], "description": "Realistic example requests for **Maryland (MD)**.\n\nMaryland Real Estate Commission (MREC) public search harvest from the DLLR query portal. Weekly scraper cadence; no published upstream cadence." }, { "name": "North Carolina (NC)", "item": [ { "name": "NC — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NC&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NC" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search North Carolina licensees with a known surname (`smith`)." }, "response": [] }, { "name": "NC — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NC&brokerage=coldwell banker advantage&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NC" }, { "key": "brokerage", "value": "coldwell banker advantage" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known North Carolina brokerage (`coldwell banker advantage`)." }, "response": [] }, { "name": "NC — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=NC&license_number=112736", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "NC" }, { "key": "license_number", "value": "112736" } ] }, "description": "Verify a known-good North Carolina license number (`112736`)." }, "response": [] } ], "description": "Realistic example requests for **North Carolina (NC)**.\n\nNorth Carolina Real Estate Commission paid monthly Licensee List ($15). Covers full brokers (B), provisional brokers (PB), and trainees (PBT) with Broker-In-Charge affiliations exposed via `relationship_type=nc_ncrec.broker_in_charge_affiliation`." }, { "name": "Wisconsin (WI)", "item": [ { "name": "WI — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=WI&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "WI" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Wisconsin licensees with a known surname (`smith`)." }, "response": [] }, { "name": "WI — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=WI&license_number=60000 - 90", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "WI" }, { "key": "license_number", "value": "60000 - 90" } ] }, "description": "Verify a known-good Wisconsin license number (`60000 - 90`)." }, "response": [] } ], "description": "Realistic example requests for **Wisconsin (WI)**.\n\nWisconsin DSPS (Department of Safety and Professional Services) public Salesforce portal search. Weekly scraper harvest covering real estate brokers, salespersons, and business entities." }, { "name": "New Mexico (NM)", "item": [ { "name": "NM — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NM&name=trujillo&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NM" }, { "key": "name", "value": "trujillo" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search New Mexico licensees with a known surname (`trujillo`)." }, "response": [] }, { "name": "NM — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=NM&license_number=0183981", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "NM" }, { "key": "license_number", "value": "0183981" } ] }, "description": "Verify a known-good New Mexico license number (`0183981`)." }, "response": [] } ], "description": "Realistic example requests for **New Mexico (NM)**.\n\nNew Mexico RLD Real Estate Commission public Salesforce portal search. Weekly scraper harvest covering associate brokers, qualifying brokers, and trade names." }, { "name": "Oklahoma (OK)", "item": [ { "name": "OK — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=OK&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "OK" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Oklahoma licensees with a known surname (`smith`)." }, "response": [] }, { "name": "OK — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=OK&license_number=140797", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "OK" }, { "key": "license_number", "value": "140797" } ] }, "description": "Verify a known-good Oklahoma license number (`140797`)." }, "response": [] } ], "description": "Realistic example requests for **Oklahoma (OK)**.\n\nOklahoma Real Estate Commission (OREC) Online License Verification, hosted on Thentia Cloud. Weekly scraper harvest covering individuals (Sales Associate, Broker Associate, Managing Broker, Branch Broker, Broker Proprietor, Provisional Sales Associate) and business facilities (LLC/Association, Corporation, Branch Office, Proprietorship, Partnership). Affiliation edges to the parent brokerage are not yet exposed from the bulk search payload." }, { "name": "Louisiana (LA)", "item": [ { "name": "LA — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=LA&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "LA" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Louisiana licensees with a known surname (`smith`)." }, "response": [] }, { "name": "LA — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=LA&brokerage=walker-alley&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "LA" }, { "key": "brokerage", "value": "walker-alley" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Louisiana brokerage (`walker-alley`)." }, "response": [] }, { "name": "LA — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=LA&license_number=09189", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "LA" }, { "key": "license_number", "value": "09189" } ] }, "description": "Verify a known-good Louisiana license number (`09189`)." }, "response": [] } ], "description": "Realistic example requests for **Louisiana (LA)**.\n\nLouisiana Real Estate Commission (LREC) public verification portal. Weekly scraper harvest covering brokers, salespersons, associate brokers, and broker companies/branches. Affiliation edges link agents to their supervising company." }, { "name": "Arkansas (AR)", "item": [ { "name": "AR — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=AR&name=smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "AR" }, { "key": "name", "value": "smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Arkansas licensees with a known surname (`smith`)." }, "response": [] }, { "name": "AR — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=AR&license_number=SA00070189", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "AR" }, { "key": "license_number", "value": "SA00070189" } ] }, "description": "Verify a known-good Arkansas license number (`SA00070189`)." }, "response": [] } ], "description": "Realistic example requests for **Arkansas (AR)**.\n\nArkansas Real Estate Commission (AREC) roster via the Arkansas Dept. of Labor & Licensing. Weekly scraper harvest covering Salespersons, Principal Brokers, Executive Brokers, Associate Brokers, Inactive Brokers, and Timeshare Brokers. Licensee-only (no affiliation edges)." }, { "name": "Nebraska (NE)", "item": [ { "name": "NE — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NE&name=Ahlvers&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NE" }, { "key": "name", "value": "Ahlvers" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Nebraska licensees with a known surname (`Ahlvers`)." }, "response": [] } ], "description": "Realistic example requests for **Nebraska (NE)**.\n\nNebraska Real Estate Commission (NREC) roster via the iGov Solutions portal. Weekly scraper harvest covering Brokers, Salespersons, and Campground Salespersons. Licensee-only (no affiliation edges)." }, { "name": "New Hampshire (NH)", "item": [ { "name": "NH — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=NH&name=WALSH&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "NH" }, { "key": "name", "value": "WALSH" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search New Hampshire licensees with a known surname (`WALSH`)." }, "response": [] }, { "name": "NH — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=NH&license_number=049285", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "NH" }, { "key": "license_number", "value": "049285" } ] }, "description": "Verify a known-good New Hampshire license number (`049285`)." }, "response": [] } ], "description": "Realistic example requests for **New Hampshire (NH)**.\n\nNew Hampshire OPLC Real Estate Commission bulk roster. Weekly scraper harvest covering Salespersons, Brokers (Principal, Associate, Managing, Temporary), Firms, Branch Offices, Trade Names, and CE/Prelicensing Instructors. Licensee-only (no affiliation edges)." }, { "name": "Idaho (ID)", "item": [ { "name": "ID — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=ID&name=KUESTER&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "ID" }, { "key": "name", "value": "KUESTER" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Idaho licensees with a known surname (`KUESTER`)." }, "response": [] }, { "name": "ID — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=ID&license_number=SP31021", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "ID" }, { "key": "license_number", "value": "SP31021" } ] }, "description": "Verify a known-good Idaho license number (`SP31021`)." }, "response": [] } ], "description": "Realistic example requests for **Idaho (ID)**.\n\nIdaho Real Estate Commission via the eDOPL portal bulk list export. Weekly scraper harvest covering Salespersons, Brokers, Companies, Branch Offices, Instructors, Providers, Cooperative Brokers, and Timeshare Registrations. Licensee-only (no affiliation edges)." }, { "name": "Indiana (IN)", "item": [ { "name": "IN — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=IN&name=Smith&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "IN" }, { "key": "name", "value": "Smith" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Indiana licensees with a known surname (`Smith`)." }, "response": [] }, { "name": "IN — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=IN&brokerage=Realty&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "IN" }, { "key": "brokerage", "value": "Realty" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Indiana brokerage (`Realty`)." }, "response": [] }, { "name": "IN — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=IN&license_number=RB14037612", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "IN" }, { "key": "license_number", "value": "RB14037612" } ] }, "description": "Verify a known-good Indiana license number (`RB14037612`)." }, "response": [] } ], "description": "Realistic example requests for **Indiana (IN)**.\n\nIndiana Professional Licensing Agency (Real Estate Commission). A pipelined harvester sweeps individual brokers from the public mylicense.in.gov portal by license-number digit branching while MuleSoft `/verifyRelatedLicense` and `/verify` workers concurrently enrich affiliation edges and discover Real Estate Broker Companies and Real Estate Branch Offices (which are not searchable on the portal at all). Weekly Phase B refresh seeds every known broker from the previous CSV and re-`/verify`s for status changes. Affiliations are exposed via `relationship_type=in_pla.manager_affiliation` (RB → RC), `in_pla.branch_manager_affiliation` (RB → BO), and `in_pla.employment_affiliation`." }, { "name": "Montana (MT)", "item": [ { "name": "MT — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MT&name=NEUHARDT&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MT" }, { "key": "name", "value": "NEUHARDT" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search Montana licensees with a known surname (`NEUHARDT`)." }, "response": [] }, { "name": "MT — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=MT&brokerage=LANDMARK&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "MT" }, { "key": "brokerage", "value": "LANDMARK" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known Montana brokerage (`LANDMARK`)." }, "response": [] }, { "name": "MT — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=MT&license_number=RRE-RBS-LIC-1504", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "MT" }, { "key": "license_number", "value": "RRE-RBS-LIC-1504" } ] }, "description": "Verify a known-good Montana license number (`RRE-RBS-LIC-1504`)." }, "response": [] }, { "name": "MT — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=MT&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "MT" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for Montana. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **Montana (MT)**.\n\nMontana Board of Realty Regulation (DLI). Source is the paid Licensee Mailing List from app.mt.gov/download, delivered as Public_Mailing_List_*.xlsx. No live scrape — the public lookup uses a custom photographic CAPTCHA. License numbers are agency-canonical (RRE-BRO-LIC-, RRE-RBS-LIC-). Licensee-only (no affiliation edges in the mailing list)." }, { "name": "South Carolina (SC)", "item": [ { "name": "SC — Search by name", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=SC&name=FRAMPTON&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "SC" }, { "key": "name", "value": "FRAMPTON" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Search South Carolina licensees with a known surname (`FRAMPTON`)." }, "response": [] }, { "name": "SC — Search by brokerage", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees?state=SC&brokerage=CAROLINA ONE REAL ESTATE&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees" ], "query": [ { "key": "state", "value": "SC" }, { "key": "brokerage", "value": "CAROLINA ONE REAL ESTATE" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Fuzzy `business_name` match on a known South Carolina brokerage (`CAROLINA ONE REAL ESTATE`)." }, "response": [] }, { "name": "SC — Verify license", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licensees/verify?state=SC&license_number=REL.62282", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licensees", "verify" ], "query": [ { "key": "state", "value": "SC" }, { "key": "license_number", "value": "REL.62282" } ] }, "description": "Verify a known-good South Carolina license number (`REL.62282`)." }, "response": [] }, { "name": "SC — Licenses search", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/licenses/search?state=SC&license_type=salesperson&page=1&per_page=10", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "licenses", "search" ], "query": [ { "key": "state", "value": "SC" }, { "key": "license_type", "value": "salesperson" }, { "key": "page", "value": "1" }, { "key": "per_page", "value": "10" } ] }, "description": "Lower-level `/licenses/search` example for South Carolina. Returns flat license rows." }, "response": [] } ], "description": "Realistic example requests for **South Carolina (SC)**.\n\nSouth Carolina Department of Labor, Licensing and Regulation (LLR) Real Estate Commission. Source is the paid monthly Request for License Roster ($10/board, S.C. Code §30-2-50 Statement of Compliance signed), fulfilled by a list-builder vendor (NORTHEAST DATAWORKS LLC) as an XLSX email attachment. No live scrape — the public Licensee Lookup is reCAPTCHA-gated. Coverage today: Associates (Sub Category A → salesperson), Brokers (B → broker_individual), and Brokers-In-Charge (BIC → broker_principal). License numbers are canonicalized as `REL.` to round-trip with the `REO.` office references the source preserves on each row. Property Managers, Provisional Associates, and Real Estate Office entities are not in the monthly delivery yet; affiliation edges to brokerage offices are recorded but not yet exposed as `AffiliationRelationship` rows pending an offices roster from LLR." } ], "description": "Per-state subfolders with realistic example values baked in. These hit the same endpoints as folder 2 but pre-fill `state` + `name` + `license_number` so you can run them with no editing.\n\nEach state folder contains:\n- **Search by name** — fuzzy name match on a real licensee surname.\n- **Search by brokerage** (where applicable) — fuzzy match on a real brokerage name.\n- **Verify license** (where we have a stable test number) — exact lookup.\n- **Search legacy (first/last)** for states that have legacy first/last filtering examples worth preserving.\n- **Licenses search** for states with `/licenses/search` examples worth preserving.\n- California also includes affiliation-history and supervisor examples." }, { "name": "6. Account & API keys", "item": [ { "name": "Get account", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/account", "description": "Returns the account associated with `{{apiKey}}`." }, "response": [] }, { "name": "Usage summary", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/account/usage", "description": "Per-month request counts for the current account. Use to estimate billing or build a usage chart." }, "response": [] }, { "name": "List API keys", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/api/v1/api-keys", "description": "Lists all keys for the current account. Only the prefix is returned; the raw secret is never re-exposed after creation." }, "response": [] }, { "name": "Create API key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": "{{baseUrl}}/api/v1/api-keys", "body": { "mode": "raw", "raw": "{\n \"label\": \"postman\"\n}" }, "description": "Creates a new API key. **The raw key (`key` field) is returned exactly once** — store it immediately. After this response only the `prefix` is recoverable." }, "response": [] }, { "name": "Revoke API key", "request": { "method": "DELETE", "header": [], "url": "{{baseUrl}}/api/v1/api-keys/{{keyId}}", "description": "Revokes (soft-deletes) the key with id `{{keyId}}`. Set `keyId` from the `id` field in `List API keys`." }, "response": [] } ], "description": "Account self-service: verify auth, see usage, and manage API keys. All require a valid bearer token. `Create API key` returns the *raw* key exactly once — store it immediately." }, { "name": "7. Billing", "item": [ { "name": "Stripe checkout", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/billing/checkout?plan=starter", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "billing", "checkout" ], "query": [ { "key": "plan", "value": "starter", "description": "starter | growth | enterprise" } ] }, "description": "Creates a Stripe Checkout Session for the given plan and returns the redirect URL. Plans are monthly only, include a card-required 7-day trial with 100 calls, and use hard caps (no overages). Requires `STRIPE_API_KEY` + plan price IDs to be configured server-side." }, "response": [] }, { "name": "Stripe customer portal", "request": { "method": "POST", "header": [], "url": "{{baseUrl}}/api/v1/billing/portal", "description": "Returns a Stripe Customer Portal URL for the account. 400 if the account has no `stripe_customer_id` (i.e. has never subscribed). Portal cancellation should be configured for end-of-period, not immediate cancellation." }, "response": [] } ], "description": "Stripe Checkout + Customer Portal helpers. These return URLs to redirect the user to. Local Docker stack ships without Stripe credentials, so these will return 400 / 500 unless you set `STRIPE_API_KEY` and price IDs." }, { "name": "8. Admin (dashboard session)", "item": [ { "name": "Ingestion runs", "request": { "method": "GET", "header": [ { "key": "Cookie", "value": "dashboard_session=PASTE_SIGNED_COOKIE", "description": "Sign in via browser at /dashboard/login, copy Cookie header" } ], "url": "{{baseUrl}}/api/v1/admin/ingestion-runs", "auth": { "type": "noauth" }, "description": "Latest 100 ingestion runs across all sources." }, "response": [] }, { "name": "Recent failures", "request": { "method": "GET", "header": [ { "key": "Cookie", "value": "dashboard_session=PASTE_SIGNED_COOKIE", "description": "Sign in via browser at /dashboard/login, copy Cookie header" } ], "url": "{{baseUrl}}/api/v1/admin/failures", "auth": { "type": "noauth" }, "description": "Latest 50 ingestion runs with status=failed." }, "response": [] }, { "name": "Admin sources", "request": { "method": "GET", "header": [ { "key": "Cookie", "value": "dashboard_session=PASTE_SIGNED_COOKIE", "description": "Sign in via browser at /dashboard/login, copy Cookie header" } ], "url": "{{baseUrl}}/api/v1/admin/sources", "auth": { "type": "noauth" }, "description": "Admin view of every source row." }, "response": [] }, { "name": "Ingest affiliation CSV (multipart)", "request": { "method": "POST", "header": [ { "key": "Cookie", "value": "dashboard_session=PASTE_SIGNED_COOKIE", "description": "Sign in via browser at /dashboard/login, copy Cookie header" } ], "url": "{{baseUrl}}/api/v1/admin/ingestions", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] }, { "key": "jurisdiction_code", "value": "US-CA", "type": "text", "description": "ISO 3166-2 jurisdiction code, e.g. US-CA" }, { "key": "format_code", "value": "ca_dre.currlist_salesperson_v1", "type": "text", "description": "Adapter format code. CA examples: ca_dre.currlist_salesperson_v1, ca_dre.salesperson_affiliation_v1, ca_dre.broker_associate_affiliation_v1, ca_dre.currlist_broker_associate_v1." } ] }, "auth": { "type": "noauth" }, "description": "Manual CSV upload, dispatched through the same adapter registry the auto-ingest uses. Mostly for backfills + dev." }, "response": [] } ], "description": "Internal endpoints used by the dashboard. **They authenticate via a signed `dashboard_session` cookie, not a bearer key.** To use them in Postman: log in via your browser at `/dashboard/login`, copy the `dashboard_session` cookie value, and paste it into each request's `Cookie` header. These are *not* part of the stable `/api/v1/*` contract." }, { "name": "9. Schemas", "item": [ { "name": "OpenAPI JSON", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/openapi.json", "auth": { "type": "noauth" }, "description": "Auto-generated OpenAPI 3 schema. Source of truth for client code generation." }, "response": [] }, { "name": "Swagger UI", "request": { "method": "GET", "header": [], "url": "{{baseUrl}}/docs", "auth": { "type": "noauth" }, "description": "Human-readable Swagger UI rendered from the same OpenAPI schema. HTML response — open in a browser tab, not Postman." }, "response": [] } ], "description": "Machine- and human-readable contract endpoints. `OpenAPI JSON` is the source of truth; `Swagger UI` is just a renderer." } ] }