{
  "openapi": "3.0.1",
  "info": {
    "title": "Secretary of State Business Entity Search + UCC Liens — KYB",
    "description": "Secretary of State (SOS) business entity search across 40 official US state registries — status, formation, registered agent lookup, officers and directors — joined to UCC lien filings in 21 states. UCC search by debtor name: secured party, status. KYB verification for lending and diligence agents.",
    "version": "0.0",
    "x-build-id": "2OO2q7vMN93zgMI2M"
  },
  "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."
          },
          "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.",
            "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 all default-covered entity registries. Extended states are searched only when named here and bill the extended per-record rate: CA, DE, GA, LA, MA, MD, MI, MO, MT, NC, NV, OH, OK, TN, UT, VA, WA. PA, NY, IA, OR and NJ are standard entity states whose lien join bills extended only when delivered. NH is searched only when named but bills the standard rate. Entities with no lien source still return in full. The COVERAGE key-value-store output is the authoritative 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. Set false for an entity-only lookup. Clean-tier lien joins cover AK, AL, AR, CO, CT, FL, ID, KY, MS, NM, RI, SC, and WI. MT, CA, PA, NY, IA, TN, NC, OH, OR, VA, WA, MI, and NJ joins are extended-coverage — name the state explicitly; PA, NY, and IA bill the extended rate only when the join is delivered. Other states return entity-only with lien_coverage='no_lien_source'. The COVERAGE key-value-store output is the authoritative 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.",
            "default": "contains"
          },
          "maxRecordsPerCompany": {
            "title": "Max entity records per company",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Safety cap on how many entity records are returned (and billed) per company name, across all searched states. Protects broad-name searches (e.g. \"Smith\") from returning hundreds of entities. Default 25.",
            "default": 25
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}