{ "openapi": "3.0.1", "info": { "title": "California Business & UCC Lien Search - bizfileOnline", "description": "Search the official California Secretary of State bizfileOnline registers. Look up business entities (status, standing, type, registered agent) or UCC liens (financing statements, judgment liens, state and federal tax liens). Filter by type, status and date. No state API key needed.", "version": "0.0", "x-build-id": "uyJYu54FGtCzeTiI5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dz_omar~california-bizfile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dz_omar-california-bizfile-scraper", "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/dz_omar~california-bizfile-scraper/runs": { "post": { "operationId": "runs-sync-dz_omar-california-bizfile-scraper", "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/dz_omar~california-bizfile-scraper/run-sync": { "post": { "operationId": "run-sync-dz_omar-california-bizfile-scraper", "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", "required": [ "searchQueries" ], "properties": { "registers": { "title": "Which registers to search?", "minItems": 1, "type": "array", "description": "Business entities returns companies — status, standing, type, registered agent. UCC liens returns filings recorded against businesses — financing statements, judgment liens, state and federal tax liens. Both are selected by default, so each search term returns both sides.", "items": { "type": "string", "enum": [ "business", "ucc" ], "enumTitles": [ "Business entities", "UCC liens" ] }, "default": [ "business", "ucc" ] }, "searchQueries": { "title": "Search terms", "minItems": 1, "type": "array", "description": "Company names, California entity numbers, or debtor / secured-party names. The registry itself truncates anything past 49 characters, so terms are limited to that. UCC search additionally needs at least 3 characters.", "items": { "type": "string", "minLength": 1, "maxLength": 49 } }, "matchType": { "title": "Search filter", "enum": [ "0", "1" ], "type": "string", "description": "How the search term is matched against names.", "default": "0" }, "searchType": { "title": "Search type", "enum": [ "1", "2" ], "type": "string", "description": "Entity Information Search uses Entity type, Status and the filing dates. Publicly Traded Disclosure Search uses the disclosure fields below instead — entity type and status do not apply to it.", "default": "1" }, "entityType": { "title": "Entity type", "enum": [ "", "51", "4102", "4101", "4103", "39", "25", "12", "37", "3", "16", "4", "33", "7", "60", "69", "70", "59", "72", "61", "32", "34", "76", "20", "55", "52", "38", "54", "53", "56", "58", "57", "23", "35", "62", "64" ], "type": "string", "description": "Entity Information Search only. Return only this entity type.", "default": "" }, "entityStatus": { "title": "Status", "enum": [ "", "1", "33", "32", "35", "34", "51", "50", "43", "45", "47", "41", "49", "52", "8", "42", "44", "46", "40", "48", "36", "53", "37", "38", "39" ], "type": "string", "description": "Entity Information Search only. Suspended and Forfeited entities have lost the right to do business in California.", "default": "" }, "filedFrom": { "title": "Filing date — start", "type": "string", "description": "Entity Information Search: initial filing date. Publicly Traded Disclosure Search: disclosure filing date. The registry uses one date range for both, switching its label with the search type." }, "filedTo": { "title": "Filing date — end", "type": "string", "description": "Entity Information Search: initial filing date. Publicly Traded Disclosure Search: disclosure filing date." }, "corporationBankruptcy": { "title": "Disclosures — Corporation Bankruptcy", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "corporationLegalProceedings": { "title": "Disclosures — Corporation Legal Proceedings", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "officerFirstName": { "title": "Director or Executive Officer — First Name", "type": "string", "description": "Publicly Traded Disclosure Search only. Search by individual name — enter at least 2 characters." }, "officerMiddleName": { "title": "Director or Executive Officer — Middle/Initial", "type": "string", "description": "Publicly Traded Disclosure Search only. Middle name or initial." }, "officerLastName": { "title": "Director or Executive Officer — Last Name", "type": "string", "description": "Publicly Traded Disclosure Search only. Search by individual name — enter at least 2 characters." }, "femaleDirectors": { "title": "Number of Female Directors on the Board", "enum": [ "143", "142", "141", "140", "99" ], "type": "string", "description": "Publicly Traded Disclosure Search only.", "default": "99" }, "underrepresentedDirectors": { "title": "Number of Underrepresented Directors on the Board", "enum": [ "143", "142", "141", "140", "99" ], "type": "string", "description": "Publicly Traded Disclosure Search only.", "default": "99" }, "compensationFrom": { "title": "Compensation — From", "type": "string", "description": "Publicly Traded Disclosure Search only. Lower bound of the reported compensation range." }, "compensationTo": { "title": "Compensation — To", "type": "string", "description": "Publicly Traded Disclosure Search only. Upper bound of the reported compensation range." }, "disclosureShares": { "title": "Disclosures — Shares", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "disclosureOptions": { "title": "Disclosures — Options", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "disclosureBankruptcy": { "title": "Disclosures — Bankruptcy", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "disclosureFraud": { "title": "Disclosures — Fraud", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "disclosureLoansToDirectors": { "title": "Disclosures — Loans to Directors", "type": "boolean", "description": "Publicly Traded Disclosure Search only.", "default": false }, "auditorName": { "title": "Independent Auditor", "type": "string", "description": "Publicly Traded Disclosure Search only. Search by auditor name — enter at least 2 characters." }, "uccStatus": { "title": "Status", "enum": [ "ALL", "ACTIVE_UNLAPSED", "ACTIVE_LAPSED_UNLAPSED" ], "type": "string", "description": "A financing statement lapses five years after filing unless the lender renews it. Active (unlapsed) returns only filings still in force.", "default": "ALL" }, "uccType": { "title": "File Type", "enum": [ "0", "2170", "2154", "2175", "2174", "2155" ], "type": "string", "description": "Return only this filing type. A Financing Statement means a lender claimed a security interest in the business's assets — normal borrowing, and it names the lender. A Judgment Lien means someone sued and won; State and Federal Tax Liens mean unpaid California or IRS tax; an Attachment means a court froze assets while a lawsuit is still pending. Those four are distress signals.", "default": "0" }, "uccFiledFrom": { "title": "File Date — start", "type": "string", "description": "Keep only liens recorded on or after this date." }, "uccFiledTo": { "title": "File Date — end", "type": "string", "description": "Keep only liens recorded on or before this date." }, "uccLapseFrom": { "title": "Lapse Date — start", "type": "string", "description": "Keep only liens that lapse on or after this date." }, "uccLapseTo": { "title": "Lapse Date — end", "type": "string", "description": "Keep only liens that lapse on or before this date — useful for finding liens about to expire." }, "detailLevel": { "title": "How much detail per result?", "enum": [ "basic", "full", "history", "documents" ], "type": "string", "description": "Search results only is fastest — one request per search. Full profile opens each result for its addresses and full agent record (one extra request per record). Filing history adds every filing and its document link (two extra per record). Download documents also fetches each filing as a PDF into the key-value store — this is by far the slowest option, since a single company can have ten or more filings; keep the result cap low when using it.", "default": "basic" }, "maxResultsPerQuery": { "title": "Max results per search term, per register", "minimum": 0, "type": "integer", "description": "Applied to each register separately, so 10 returns up to 10 business records AND up to 10 UCC records per search term — 20 in total when Both is selected. Leave at 0 to keep every match. The business register returns at most 500 matches per term; UCC refuses terms matching more than 1,000 filings.", "default": 50 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "The registry refuses datacenter addresses, so runs go out through a US residential proxy. Leave this as it is unless you are supplying your own residential proxy — turning it off will make the registry reject the run.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }