{
  "openapi": "3.0.1",
  "info": {
    "title": "Secretary of State Business Entity Search + UCC Liens — KYB",
    "description": "Secretary of State (SOS) business registry search, 48 states + DC (Florida Sunbiz): company registration lookup, company lookup by name. Registered agent search and officer search: list companies by agent or officer (9 states). UCC liens (31 states), UCC search by debtor. KYB business verification",
    "version": "0.0",
    "x-build-id": "MZbaFMoVksovXsKll"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/shelvick~business-entity-lien-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-shelvick-business-entity-lien-search",
        "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/shelvick~business-entity-lien-search/runs": {
      "post": {
        "operationId": "runs-sync-shelvick-business-entity-lien-search",
        "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/shelvick~business-entity-lien-search/run-sync": {
      "post": {
        "operationId": "run-sync-shelvick-business-entity-lien-search",
        "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": {
          "companyName": {
            "title": "Company name",
            "type": "string",
            "description": "Required unless you use Company names (batch). Enter the business / company name to search for, e.g. \"Tesla\" or \"Acme Holdings LLC\". Matched against official state business registries. Use Name match mode to control exact vs. partial matching. Directory-style qualifiers a registry never holds (\"formerly ...\", \"dba ...\", \"a Div. of ...\") are removed before the search; the record's message names what was searched. Used when searchBy is 'company'."
          },
          "companyNames": {
            "title": "Company names (batch)",
            "maxItems": 20,
            "type": "array",
            "description": "Required unless you use Company name. Add multiple company names to look up in one run (one per line), e.g. \"Acme Holdings LLC\" — useful for verifying a list of counterparties. Each name is resolved and billed independently. Directory-style qualifiers a registry never holds (\"formerly ...\", \"dba ...\", \"a Div. of ...\") are removed before the search; the record's message names what was searched. Used when searchBy is 'company'.",
            "items": {
              "type": "string"
            }
          },
          "states": {
            "title": "States to search",
            "type": "array",
            "description": "Two-letter US state codes to scope the search, e.g. [\"CO\",\"CT\",\"NY\"]. Empty searches every default-covered entity registry. These are searched only when named here and bill the extended per-record rate: AZ, CA, DE, IN, LA, MA, MD, MI, MT, NC, NV, OH, OK, SC, SD, TN, UT, WA, WY. NH, VA, MO and GA are named-only at the standard rate (VA/MO lien joins extended). In PA, NY, IA, NJ and VT only a delivered lien join bills extended; OR, HI and DC joins bill standard. COVERAGE output is the live list.",
            "items": {
              "type": "string"
            }
          },
          "includeLiens": {
            "title": "Include UCC / lien filings",
            "type": "boolean",
            "description": "When true (default), each resolved entity is joined to UCC / lien filings where available; false = entity-only. Default lien joins: AK, AL, AR, CO, CT, FL, ID, KY, MS, NM, RI, WI, plus OK and SC when those states are named in `states`. Joins only when the state is named in `states`: CA, DC, HI, IA, MD, MI, MO, MT, NC, NJ, NY, OH, OR, PA, TN, VA, VT, WA (billing: see `states`). Other states return entity-only with lien_coverage='no_lien_source'. COVERAGE output is the live list.",
            "default": true
          },
          "matchMode": {
            "title": "Name match mode",
            "enum": [
              "contains",
              "exact",
              "starts"
            ],
            "type": "string",
            "description": "How to match the company name against the registry. 'contains' (default) is broadest — good for discovering all entities sharing a name. 'exact' returns only entities whose legal name equals the query. 'starts' matches names beginning with the query. In 'exact', punctuation and spacing are ignored, but the legal-form suffix must match — LLC, Inc and Corp are different entities; a name typed with no form at all also matches the one registered name that differs from it only by its form.",
            "default": "contains"
          },
          "maxRecordsPerCompany": {
            "title": "Max entity records per company",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Cap on entity records returned (and billed) per company name, across all searched states. Default 25. Matches past the cap are not returned and the row carries results_truncated=true, so a very low cap can drop the entity you are looking for: in 'contains' mode one name often matches several registered entities in a single state. To bound cost, scope `states` first and use a very low cap only when any one match will do.",
            "default": 25
          },
          "reportType": {
            "title": "Report type",
            "enum": [
              "standard",
              "due_diligence"
            ],
            "type": "string",
            "description": "'standard' (default): registry records with lien joins. 'due_diligence' adds per company: run-time registry status with timestamp and standing, a recent-financing summary from the UCC join, a sanctions-list screen and a recorded-lien bundle. Exact name match; up to 5 companies per run, 3 records each by default. If current status can't be confirmed, the record returns as standard at the standard price (reason in due_diligence). Not a good-standing certificate, TIN check or consumer report.",
            "default": "standard"
          },
          "searchBy": {
            "title": "Search by",
            "enum": [
              "company",
              "registeredAgent",
              "officer",
              "address"
            ],
            "type": "string",
            "description": "What to search by. 'company' (default) looks companies up by name. 'registeredAgent', 'officer' and 'address' search in reverse: they list the companies on file in a state's business register that have that registered agent, list that person or firm as an officer, or use that street address — e.g. the companies a registered agent represents. Covered states are named in partyName and streetAddress. Each company row bills like a company record; lien filings are not joined.",
            "default": "company"
          },
          "partyName": {
            "title": "Agent / officer name",
            "type": "string",
            "description": "For searchBy 'registeredAgent' or 'officer': the agent's or officer's name, e.g. 'Example Agent Services LLC'. Lists the companies that name it as registered agent (FL, IA, AK, CO, IL, KY, RI, WV) or as an officer or manager (FL, AK, WV; in IL only a president or secretary, on file for about half of IL companies). matchMode 'contains' (default) matches all words in any order; 'exact' matches the whole name."
          },
          "streetAddress": {
            "title": "Street address",
            "type": "string",
            "description": "For searchBy 'address': the street line, e.g. '7901 4th St N Ste 300'. Lists companies whose principal, mailing or registered-agent office address is that line in streetZip. Street-type spellings (Street/St) are folded; a suite number must match. States: FL, IA, AK, CO, IL, KY, RI, WV, MS — about a quarter of WV records have no searchable address."
          },
          "streetZip": {
            "title": "Street ZIP code",
            "type": "string",
            "description": "For searchBy 'address': the 5-digit ZIP code of streetAddress. Required for address search."
          },
          "entityStatus": {
            "title": "Entity status filter",
            "enum": [
              "any",
              "active",
              "inactive"
            ],
            "type": "string",
            "description": "Reverse-search filter: only 'active' or only 'inactive' companies ('any' = both). Each state reports standing in its own terms; ambiguous standings (for example 'delinquent') match neither. Not available for Rhode Island; Iowa and Alaska list current companies only.",
            "default": "any"
          },
          "entityTypes": {
            "title": "Entity type filters",
            "type": "array",
            "description": "Reverse-search filter: keep only these company types: llc, corporation, nonprofit, partnership, other. Empty keeps every type.",
            "items": {
              "type": "string",
              "enum": [
                "llc",
                "corporation",
                "nonprofit",
                "partnership",
                "other"
              ],
              "enumTitles": [
                "LLC",
                "Corporation",
                "Nonprofit",
                "Partnership",
                "Other"
              ]
            },
            "default": []
          },
          "formedFrom": {
            "title": "Formed from",
            "type": "string",
            "description": "Reverse-search filter: only companies formed or registered on or after this date (YYYY-MM-DD). Combine with formedTo for a date range, e.g. the companies a registered agent formed this month."
          },
          "formedTo": {
            "title": "Formed to",
            "type": "string",
            "description": "Reverse-search filter: only companies formed or registered on or before this date (YYYY-MM-DD)."
          },
          "city": {
            "title": "City filter",
            "type": "string",
            "description": "Registered-agent and officer search filter: only companies whose principal address (or, when none, mailing address) is in this city."
          },
          "zipFilter": {
            "title": "ZIP code filter",
            "type": "string",
            "description": "Registered-agent and officer search filter: only companies whose principal address (or, when none, mailing address) has this 5-digit ZIP code."
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Reverse search: the most company rows this run returns and bills, across all states (default 100, up to 10,000). When a list is longer, the last row and the run's OUTPUT carry resume_cursor to continue it in another run.",
            "default": 100
          },
          "maxResultsPerState": {
            "title": "Max results per state",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Reverse search: optional limit per state within maxResults, so one large state cannot use the whole run."
          },
          "resumeCursor": {
            "title": "Resume cursor",
            "type": "string",
            "description": "Reverse search: continue a list where an earlier run stopped (maximum charge, time limit or maxResults). Paste that run's resume_cursor with the same search settings; companies already returned are not repeated."
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}