{ "openapi": "3.0.1", "info": { "title": "DBPR Florida License Verification", "description": "Verify any Florida professional license (contractors, real estate, cosmetology, CPAs, engineers, and 30+ other boards) directly from the Florida Department of Business and Professional Regulation. Fresher than aggregators, priced per record.", "version": "0.2", "x-build-id": "TckjcKkZGcOoBaW6X" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ws_tony~dbpr-florida-license-verification/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ws_tony-dbpr-florida-license-verification", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/ws_tony~dbpr-florida-license-verification/runs": { "post": { "operationId": "runs-sync-ws_tony-dbpr-florida-license-verification", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/ws_tony~dbpr-florida-license-verification/run-sync": { "post": { "operationId": "run-sync-ws_tony-dbpr-florida-license-verification", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "licenseNumbers": { "title": "License numbers to look up", "type": "array", "description": "List of DBPR license numbers (e.g. `CFC056678`, `CGC1512345`, `SL705188`). Direct lookup — skips the name search and goes straight to the record. Cheapest path per record.", "default": [], "items": { "type": "string" } }, "licenseeNames": { "title": "Licensee names to search", "type": "array", "description": "List of names to search. Each entry is either a single string (treated as last name) or an object `{\"lastName\": \"SMITH\", \"firstName\": \"JOHN\"}` or `{\"orgName\": \"AARDVARK PLUMBING\"}`. Partial matches are returned.", "default": [] }, "citySearches": { "title": "City searches", "type": "array", "description": "Find licensees of a specific license type in a specific city / county. **DBPR requires both `board` and `licenseType` on these searches** (e.g. `06` + `0605` = Certified General Contractor). Entry shape: `{\"city\": \"TAMPA\", \"board\": \"06\", \"licenseType\": \"0605\"}` or `{\"county\": \"39\", \"board\": \"06\", \"licenseType\": \"0605\"}` (county = Hillsborough). Optional `state` defaults to `FL`; use `NA` for out-of-state licensees. See README for board + license-type codes.", "default": [] }, "licenseTypeSearches": { "title": "License-type searches", "type": "array", "description": "Find all licensees of a given type across a geography. Entry shape: `{\"board\": \"06\", \"licenseType\": \"0605\"}` (defaults to out-of-state), or add `\"city\"`/`\"county\"`/`\"state\"` to narrow. Both `board` and `licenseType` are required (DBPR constraint). To cover all of Florida, iterate over counties (there are 67). Great for snapshotting every active CGC, plumber, or CPA in a county.", "default": [] }, "enrichmentLevel": { "title": "Enrichment level", "enum": [ "basic", "full" ], "type": "string", "description": "`basic` returns what the search-results page shows: license #, name, type, status, expiration, main address. `full` additionally fetches the per-license detail page for: licensure date, county, DBA/alternate names, and special qualifications.", "default": "basic" }, "statusCheckOnly": { "title": "Status-check mode", "type": "boolean", "description": "If true, only charges `license_status_check` ($0.002) per license number and returns `{license_number, status, status_normalized, expiration_date}` — no name, address, or other PII. Only works with `licenseNumbers` input. Great for renewal-reminder workflows.", "default": false }, "maxResultsPerSearch": { "title": "Max results per name/city/type search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on how many licensees to return per search. DBPR can return thousands (e.g. 25,000+ Smiths) — cap low unless you intend to pay for all of them.", "default": 50 }, "includeExpired": { "title": "Include expired / null-and-void licenses", "type": "boolean", "description": "If true, all license statuses are returned. If false (default), only licenses with `Current` or `Active` status are kept — cheaper and usually what verification workflows want.", "default": false }, "maxConcurrency": { "title": "Parallel workers", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of searches to run in parallel. DBPR tolerates bursts but is a single IIS host — keep this modest.", "default": 3 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 10, "maximum": 300, "type": "integer", "description": "HTTP request timeout for each page fetch.", "default": 90 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "DBPR is a public state government site with no Cloudflare and no aggressive rate limiting — going direct is the most reliable. Apify's shared datacenter proxies sometimes return UPSTREAM502 errors mid-run when talking to DBPR, so proxy is OFF by default. Turn it on only if you need to avoid leaking the run's source IP.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }