CivicDataForge Public-Records Data

{'type': 'object', 'required': ['runId'], 'properties': {'runId': {'type': 'string', 'minLength': 1, 'description': 'Actor run ID to abort.'}, 'gracefully': {'type': 'boolean', 'description': 'Request a graceful abort with the provider timeout.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['task', 'subject'], 'properties': {'task': {'enum': ['us_property_decision', 'india_company_evidence', 'india_supplier_pack', 'restricted_party_screening', 'epa_facility_evidence', 'earth_observation_evidence', 'china_counterparty_intake'], 'type': 'string', 'title': 'Evidence task'}, 'purpose': {'type': 'string', 'title': 'Purpose'}, 'subject': {'type': 'object', 'title': 'Exact subject identifiers', 'additionalProperties': True}, 'evidence': {'type': 'array', 'items': {'type': 'object', 'additionalProperties': True}, 'title': 'Rights-labeled customer or licensed evidence', 'default': []}, 'retentionDays': {'type': 'integer', 'title': 'Packet retention days', 'default': 30, 'maximum': 365, 'minimum': 0}, 'batchReference': {'type': 'string', 'title': 'Customer batch reference', 'maxLength': 120}, 'transactionGate': {'type': 'boolean', 'title': 'Include caller-policy transaction state', 'default': False}, 'previousReceiptHash': {'type': 'string', 'title': 'Previous evidence-state receipt', 'pattern': '^sha256:[a-f0-9]{64}$'}, 'screenRestrictedParties': {'type': 'boolean', 'title': 'Screen China-facing subject against the U.S. ITA CSL', 'default': True}}, 'description': 'Route a U.S., India, global screening, EPA, or China-facing evidence task through one receipt-bound contract.'}

{'type': 'object', 'properties': {'zip': {'type': 'string', 'title': 'ZIP code', 'pattern': '^[0-9]{5}(-[0-9]{4})?$'}, 'city': {'type': 'string', 'title': 'City', 'maxLength': 100}, 'state': {'type': 'string', 'title': 'State', 'pattern': '^[A-Za-z]{2}$'}, 'facilityId': {'type': 'string', 'title': 'EPA FRS Registry ID', 'pattern': '^[0-9]{12}$', 'description': 'Exact 12-digit Facility Registry Service ID, for example 110000367567.'}, 'facilityName': {'type': 'string', 'title': 'Facility name', 'maxLength': 200, 'minLength': 3, 'description': 'Published facility name. Add location fields to reduce ambiguity.'}, 'maxCandidates': {'type': 'integer', 'title': 'Maximum candidates', 'default': 5, 'maximum': 10, 'minimum': 1}, 'nameMatchMode': {'enum': ['exact', 'contains', 'begins'], 'type': 'string', 'title': 'Name matching', 'default': 'exact', 'description': 'Exact is the responsible default. Contains is discovery-only and may require review.'}, 'streetAddress': {'type': 'string', 'title': 'Street address', 'maxLength': 200, 'minLength': 5, 'description': 'Full or partial published street address. Address-only searches also require city, state, or ZIP.'}, 'includeProgramDetails': {'type': 'boolean', 'title': 'Retrieve program details', 'default': True}}, 'description': 'Provide a 12-digit EPA FRS Registry ID, or a bounded facility name/address query. Exact FRS ID is the strongest selector.'}

{'type': 'object', 'properties': {'city': {'type': 'string', 'title': 'City', 'editor': 'textfield', 'nullable': True, 'description': 'Filter by property location city (e.g. Kissimmee, Orlando, Destin). Leave empty for all.'}, 'county': {'type': 'string', 'title': 'County', 'editor': 'textfield', 'prefill': 'Orange', 'nullable': True, 'description': 'Filter to one Florida county by property location (e.g. Orange, Osceola, Dade, Monroe, St. Johns). Leave empty for statewide.'}, 'status': {'enum': ['all', 'current', 'delinquent'], 'type': 'string', 'title': 'License status', 'editor': 'select', 'default': 'all', 'prefill': 'current', 'enumTitles': ['All licenses', 'Current only', 'Delinquent only'], 'description': 'Current = up to date with DBPR; Delinquent = license not renewed on time (expiry date has passed).'}, 'maxRecords': {'type': 'integer', 'title': 'Max records', 'default': 100, 'minimum': 1, 'prefill': 25, 'description': 'Cap total records returned (statewide is ~174k).'}, 'licenseType': {'enum': ['all', 'condo', 'dwelling'], 'type': 'string', 'title': 'License type', 'editor': 'select', 'default': 'all', 'enumTitles': ['Both types', 'Vacation Rental — Condo', 'Vacation Rental — Dwelling'], 'description': 'DBPR licenses vacation rentals as Condos (type 2006) or Dwellings (type 2007, incl. single-family homes & townhouses).'}, 'nameContains': {'type': 'string', 'title': 'Name contains', 'editor': 'textfield', 'nullable': True, 'description': 'Case-insensitive substring match on the business name or licensee name.'}, 'proxyConfiguration': {'type': 'object', 'title': 'Proxy', 'editor': 'proxy', 'default': {'useApifyProxy': True}, 'prefill': {'useApifyProxy': True}, 'description': 'The state site blocks plain datacenter traffic; Apify Proxy is used by default. Switch to residential if datacenter IPs get blocked.'}}}

{'type': 'object', 'properties': {'mode': {'enum': ['screen', 'filter'], 'type': 'string', 'title': 'Mode', 'editor': 'select', 'default': 'screen', 'prefill': 'filter', 'enumTitles': ['Screen a list', 'Filter the LEIE list'], 'description': 'screen checks people/entities and returns evidence records; filter pulls source LEIE records with provenance.'}, 'state': {'type': 'string', 'title': 'State (filter mode)', 'editor': 'textfield', 'prefill': 'FL', 'nullable': True, 'description': 'Two-letter state code, for example TX.'}, 'enrichNpi': {'type': 'boolean', 'title': 'Resolve identity with CMS NPPES', 'default': True, 'description': 'Look up matched LEIE NPIs or a caller-supplied NPI in the official CMS registry and return explainable correlation signals. NPI status is not licensure or eligibility.'}, 'samApiKey': {'type': 'string', 'title': 'SAM.gov API key', 'editor': 'textfield', 'isSecret': True, 'description': 'Caller-supplied SAM.gov public API key. Required only when includeSam is enabled; never returned in output.'}, 'specialty': {'type': 'string', 'title': 'Specialty (filter mode)', 'editor': 'textfield', 'nullable': True, 'description': 'Substring match on specialty, such as NURSING, PHARMACY, or HOME HEALTH.'}, 'includeSam': {'type': 'boolean', 'title': 'Also check SAM.gov active exclusions', 'default': False, 'description': 'Opt in to the official GSA SAM.gov Exclusions API. Requires your own public SAM.gov API key.'}, 'maxRecords': {'type': 'integer', 'title': 'Max records (filter mode)', 'default': 100, 'minimum': 1, 'prefill': 50, 'nullable': True, 'description': 'Caps LEIE records returned in filter mode.'}, 'screenList': {'type': 'array', 'items': {'type': 'object', 'properties': {'npi': {'type': 'string', 'title': 'NPI', 'pattern': '^[0-9]{10}$', 'description': 'Optional 10-digit NPI. The Actor also validates the NPI check digit and rejects invalid values.'}, 'ref': {'type': 'string', 'title': 'Caller reference', 'description': 'Optional caller reference returned with the evidence record.'}, 'name': {'type': 'string', 'title': 'Name', 'minLength': 1, 'description': 'Person or entity name. Required when NPI is omitted.'}, 'state': {'type': 'string', 'title': 'State', 'pattern': '^[A-Za-z]{2}$', 'description': 'Optional two-letter state used to constrain name candidates.'}}}, 'title': 'People / entities to screen', 'editor': 'json', 'default': [], 'maxItems': 500, 'description': 'For screen mode. Each item: { "name": "JOHN SMITH" or "ACME HOME HEALTH", "npi": "1234567893" (optional valid test NPI), "state": "NC" (optional), "ref": "your-id" (optional) }. Name-only matches are normalized exact-name candidates, constrained by state when supplied, and require human review.'}, 'exclusionType': {'type': 'string', 'title': 'Exclusion type (filter mode)', 'editor': 'textfield', 'nullable': True, 'description': 'OIG exclusion authority code, such as 1128a1 or 1128b5.'}, 'maxNpiLookups': {'type': 'integer', 'title': 'Maximum CMS NPI lookups', 'default': 10, 'maximum': 25, 'minimum': 0, 'description': 'Caps NPPES calls per run. Remaining rows still receive LEIE results and show that enrichment was skipped.'}, 'maxSamQueries': {'type': 'integer', 'title': 'Maximum SAM.gov queries', 'default': 10, 'maximum': 10, 'minimum': 0, 'description': "Caps SAM.gov calls per run to respect the official API's role-dependent rate limits."}}}

{'type': 'object', 'properties': {'county': {'type': 'string', 'title': 'County', 'editor': 'textfield', 'nullable': True, 'description': "Filter to one county (e.g. 'Sussex', 'Oneida', 'Boulder'). Applied server-side where the state feed carries a county column; CT publishes no county so a county filter returns no CT rows. Leave empty for statewide."}, 'states': {'type': 'array', 'title': 'States', 'editor': 'stringList', 'default': ['CT'], 'prefill': ['CT'], 'nullable': True, 'description': 'Which states to pull. Available: NY (16.8k facilities), NJ (4.2k), CO (4.5k), CT (16.2k + inspections), DE (1.2k + inspections & deficiencies). Leave empty for all five.'}, 'licenseStatus': {'type': 'string', 'title': 'License status', 'editor': 'textfield', 'nullable': True, 'description': "Case-insensitive substring match on the facility's license status (e.g. 'ACTIVE', 'License', 'Licensed'). Leave empty for all statuses."}, 'minDeficiencies': {'type': 'integer', 'title': 'Min cited deficiencies', 'minimum': 0, 'nullable': True, 'description': 'Only return facilities with at least this many cited deficiencies (compliance screening). Deficiency counts are published only by Delaware; other states have none, so this filter excludes them.'}, 'maxInspectionRows': {'type': 'integer', 'title': 'Max inspection rows per state', 'default': 200, 'minimum': 1, 'prefill': 50, 'nullable': True, 'description': 'Cap the inspection/deficiency rows fetched per state before building the per-facility compliance lookup (leave empty to read the full feed; CT ships ~97k inspection rows).'}, 'includeInspections': {'type': 'boolean', 'title': 'Include inspection / deficiency data', 'default': False, 'prefill': False, 'description': "When on, fetch each state's inspection/deficiency feed and merge per-facility inspection_count and (DE) deficiency_count + top cited regulations. Turn off for a faster, licensing-only pull. Only affects CT and DE."}, 'maxRecordsPerState': {'type': 'integer', 'title': 'Max records per state', 'default': 50, 'minimum': 1, 'prefill': 25, 'nullable': True, 'description': 'Cap the number of facility records pulled from each state (leave empty for the full registry).'}}}

{'type': 'object', 'required': ['queries'], 'properties': {'queries': {'type': 'array', 'items': {'type': 'object', 'required': ['purpose'], 'properties': {'name': {'type': 'string', 'title': 'Entity name', 'maxLength': 180, 'minLength': 2, 'description': "Bounded official name search. The API's published candidates are returned; ambiguous candidates are not silently resolved."}, 'purpose': {'enum': ['ENTITY_VERIFICATION', 'SUPPLIER_ONBOARDING_EVIDENCE', 'PROCUREMENT_RESEARCH', 'OTHER'], 'type': 'string', 'title': 'Evidence purpose', 'editor': 'select', 'enumTitles': ['Entity verification', 'Supplier onboarding evidence', 'Procurement research', 'Other evidence purpose'], 'description': 'Caller-declared workflow context recorded in the receipt; it never changes source facts or produces an eligibility verdict.'}, 'reference': {'type': 'string', 'title': 'Caller reference', 'maxLength': 200, 'description': 'Optional non-sensitive caller reference bound into the evidence receipt.'}, 'organisationNumber': {'type': 'string', 'title': 'Organisation number', 'description': 'Exact nine-digit Norwegian organisation number.'}, 'previousRecordReceipts': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Previous record receipts', 'editor': 'stringList', 'maxItems': 50, 'description': 'Optional prior record receipt hashes used only for deterministic added, removed, or unchanged classification.'}, 'previousDecisionReceiptHash': {'type': 'string', 'title': 'Previous decision receipt', 'description': 'Optional prior SHA-256 decision receipt used only for deterministic change classification.'}}}, 'title': 'Company queries', 'editor': 'json', 'prefill': [{'purpose': 'SUPPLIER_ONBOARDING_EVIDENCE', 'reference': 'supplier-no-001', 'organisationNumber': '974760673'}], 'maxItems': 25, 'minItems': 1, 'description': 'One to 25 evidence queries. Prefer the exact nine-digit organisation number. A supplied name alongside an organisation number is returned as a consistency check, never as a replacement identifier.'}, 'maxRecords': {'type': 'integer', 'title': 'Maximum returned name candidates', 'editor': 'number', 'default': 10, 'maximum': 50, 'minimum': 1, 'description': 'Name searches request one additional record internally so truncation is detected and disclosed.'}, 'batchReference': {'type': 'string', 'title': 'Batch reference', 'editor': 'textfield', 'maxLength': 200, 'description': 'Optional non-sensitive batch reference bound into the shared batch receipt.'}}}

{'type': 'object', 'properties': {'cities': {'type': 'array', 'items': {'enum': ['chicago', 'nyc', 'san_francisco', 'austin'], 'type': 'string', 'enumTitles': ['Chicago, IL', 'New York City, NY', 'San Francisco, CA', 'Austin, TX']}, 'title': 'Cities', 'editor': 'select', 'default': ['austin'], 'prefill': ['austin'], 'description': 'Which city building code-enforcement / property-violation registries to pull.'}, 'status': {'enum': ['all', 'open'], 'type': 'string', 'title': 'Violation status filter', 'editor': 'select', 'default': 'all', 'prefill': 'open', 'enumTitles': ['All violations', 'Open / active only'], 'description': 'Return all violations, or only currently OPEN/active ones (the distress signal buyers usually want).'}, 'maxRecordsPerCity': {'type': 'integer', 'title': 'Max records per city', 'default': 100, 'minimum': 1, 'prefill': 25, 'nullable': True, 'description': 'Cap records per city, newest first (leave empty to pull the full registry).'}}}

{'type': 'object', 'properties': {'since': {'type': 'string', 'title': 'Inspections since', 'editor': 'textfield', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'nullable': True, 'description': 'Inclusive ISO date YYYY-MM-DD.'}, 'until': {'type': 'string', 'title': 'Inspections through', 'editor': 'textfield', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'nullable': True, 'description': 'Inclusive ISO date YYYY-MM-DD.'}, 'cities': {'type': 'array', 'items': {'enum': ['nyc', 'chicago', 'austin', 'cincinnati', 'boulder', 'montgomery', 'king_county'], 'type': 'string', 'enumTitles': ['New York City, NY', 'Chicago, IL', 'Austin, TX', 'Cincinnati, OH', 'Boulder County, CO', 'Montgomery County, MD', 'King County, WA']}, 'title': 'Jurisdictions', 'editor': 'select', 'default': ['chicago'], 'prefill': ['chicago'], 'description': 'Official inspection feeds to query. Every output and run receipt discloses source age, row grain, and source status.'}, 'resultContains': {'type': 'string', 'title': 'Result or grade contains', 'editor': 'textfield', 'nullable': True, 'description': "Case-insensitive substring on the jurisdiction's published result or grade. A source with no such field returns no matches; scores are never guessed into grades."}, 'socrataAppToken': {'type': 'string', 'title': 'Socrata application token', 'editor': 'textfield', 'isSecret': True, 'nullable': True, 'description': 'Optional caller-owned app token for a dedicated Socrata rate-limit pool. It is sent only as X-App-Token and never returned.'}, 'maxRecordsPerCity': {'type': 'integer', 'title': 'Maximum records per jurisdiction', 'default': 100, 'maximum': 5000, 'minimum': 1, 'prefill': 25, 'description': 'Bounded newest-first query limit per jurisdiction (1-5,000).'}, 'businessNameContains': {'type': 'string', 'title': 'Business name contains', 'editor': 'textfield', 'nullable': True, 'description': 'Case-insensitive establishment-name substring. Applied server-side where supported and verified client-side for every source.'}}}

{'type': 'object', 'properties': {'cities': {'type': 'array', 'items': {'enum': ['seattle', 'orlando', 'new_orleans', 'denver', 'chicago', 'marin', 'norfolk', 'nashville', 'osceola_county', 'polk_county', 'austin', 'houston', 'sacramento', 'san_bernardino', 'bend', 'aspen', 'philadelphia', 'albuquerque', 'asheville', 'louisville', 'arlington', 'san_diego', 'scottsdale', 'huntington_beach', 'coconino', 'san_juan', 'chattanooga', 'boston', 'kansas_city'], 'type': 'string', 'enumTitles': ['Seattle, WA', 'Orlando, FL', 'New Orleans, LA', 'Denver, CO', 'Chicago, IL', 'Marin County, CA', 'Norfolk, VA', 'Nashville, TN', 'Osceola County, FL', 'Polk County, FL', 'Austin, TX', 'Houston, TX', 'Sacramento, CA', 'San Bernardino County, CA', 'Bend, OR', 'Aspen, CO', 'Philadelphia, PA', 'Albuquerque, NM', 'Asheville, NC', 'Louisville, KY', 'Arlington, TX', 'San Diego, CA', 'Scottsdale, AZ', 'Huntington Beach, CA', 'Coconino County, AZ', 'San Juan County, WA', 'Chattanooga, TN', 'Boston, MA', 'Kansas City, MO']}, 'title': 'Cities', 'editor': 'select', 'default': ['orlando'], 'prefill': ['orlando'], 'description': 'Which of the 29 covered cities to pull. Published fields vary by city — see the README coverage table.'}, 'status': {'enum': ['all', 'active'], 'type': 'string', 'title': 'Permit status filter', 'editor': 'select', 'default': 'all', 'prefill': 'active', 'enumTitles': ['All permits', 'Active only'], 'description': 'Return all permits, or only currently-active licenses.'}, 'snapshot': {'type': 'boolean', 'title': 'Monitor changes from a complete pull', 'default': False, 'description': 'Persist a query-scoped baseline and compare it with the prior complete run. Requires maxRecordsPerCity to be cleared; capped results are rejected so they cannot create false disappearance alerts.'}, 'maxRecordsPerCity': {'type': 'integer', 'title': 'Max records per city', 'default': 50, 'minimum': 1, 'prefill': 25, 'nullable': True, 'description': 'Cap records per city (leave empty for the full registry).'}, 'resolveJurisdiction': {'type': 'boolean', 'title': 'Resolve governing jurisdiction', 'default': True, 'description': 'Use coordinates and Census boundaries to distinguish an incorporated city from an unincorporated county area. Disable for a faster raw-source pull.'}}}

{'type': 'object', 'properties': {'county': {'type': 'string', 'title': 'County', 'editor': 'textfield', 'prefill': 'Travis', 'nullable': True, 'description': 'Filter to one Texas county (e.g. HARRIS, DALLAS, TRAVIS). Leave empty for statewide.'}, 'maxRecords': {'type': 'integer', 'title': 'Max records', 'default': 100, 'minimum': 1, 'prefill': 25, 'nullable': True, 'description': 'Cap total records (leave empty for the full registry, ~100k).'}, 'operationType': {'type': 'string', 'title': 'Operation type', 'editor': 'textfield', 'nullable': True, 'description': "e.g. 'Licensed Center', 'Licensed Child-Care Home', 'Listed Family Home'. Leave empty for all."}, 'minHighDeficiencies': {'type': 'integer', 'title': 'Min high-severity deficiencies', 'minimum': 0, 'nullable': True, 'description': 'Only return operations with at least this many high-severity deficiencies (compliance screening).'}}}

{'type': 'object', 'required': ['runId'], 'properties': {'runId': {'type': 'string', 'minLength': 1, 'description': 'Actor run ID.'}, 'waitSecs': {'type': 'integer', 'default': 30, 'maximum': 45, 'minimum': 0, 'description': 'Seconds to wait for a terminal state.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['datasetId'], 'properties': {'desc': {'type': 'boolean'}, 'omit': {'type': 'string'}, 'clean': {'type': 'boolean'}, 'limit': {'type': 'integer', 'minimum': 1}, 'fields': {'type': 'string'}, 'offset': {'type': 'number'}, 'flatten': {'type': 'string'}, 'datasetId': {'type': 'string', 'minLength': 1, 'description': 'Dataset ID or username~dataset-name.'}}, 'additionalProperties': False}

{'type': 'object', 'required': ['keyValueStoreId', 'recordKey'], 'properties': {'recordKey': {'type': 'string', 'minLength': 1, 'description': 'Exact record key.'}, 'keyValueStoreId': {'type': 'string', 'minLength': 1, 'description': 'Key-value store ID or username~store-name.'}}, 'additionalProperties': False}