{ "openapi": "3.0.1", "info": { "title": "Contractor License Verification: Multi-State", "description": "Verify contractor licenses across supported U.S. official state registries by license number or company name. Retain match evidence, source coverage, expiry fields, batch review rows, and explainable monitoring. $0.00352 per verification result.", "version": "0.1", "x-build-id": "zTfRPRuKmY5Vpgukt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~multistate-contractor-license-verifier/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-multistate-contractor-license-verifier", "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/getascraper~multistate-contractor-license-verifier/runs": { "post": { "operationId": "runs-sync-getascraper-multistate-contractor-license-verifier", "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/getascraper~multistate-contractor-license-verifier/run-sync": { "post": { "operationId": "run-sync-getascraper-multistate-contractor-license-verifier", "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": { "checks": { "title": "Contractors to verify", "maxItems": 250, "type": "array", "description": "Submit up to 250 named contractors or license numbers. Every inputId must be unique. A license-number match is stronger than a company-name candidate and every candidate retains official-source evidence.", "items": { "type": "object", "properties": { "inputId": { "title": "Your reference", "description": "Optional value copied to the verification result.", "type": "string" }, "state": { "title": "Registry state", "description": "Official registry state to query for this contractor.", "type": "string", "enum": [ "CT", "IL", "OR", "TX", "WA" ] }, "licenseNumber": { "title": "License number", "description": "Published license or registration number, when available.", "type": "string" }, "companyName": { "title": "Company name", "description": "Published company or contractor name used for candidate matching.", "type": "string" } } }, "default": [ { "inputId": "sample-wa-license", "state": "WA", "licenseNumber": "04CONCL862CR" } ] }, "checksCsv": { "title": "Paste contractor CSV", "type": "string", "description": "Paste a header row using inputId,state,licenseNumber,companyName followed by up to 250 checks. inputId is optional but must be unique when supplied; every row needs a supported state and either licenseNumber or companyName. Quoted commas and line breaks are supported. When CSV is supplied, it takes precedence over the JSON list." }, "state": { "title": "Single-check state", "enum": [ "CT", "IL", "OR", "TX", "WA" ], "type": "string", "description": "Use these single-check fields instead of the batch list when verifying one contractor. Pasted CSV takes precedence; otherwise populated single-check fields take precedence over the JSON list." }, "licenseNumber": { "title": "Single-check license number", "type": "string", "description": "Published license or registration number for one contractor." }, "companyName": { "title": "Single-check company name", "type": "string", "description": "Published company or contractor name for one candidate search." }, "maxCandidatesPerCheck": { "title": "Maximum candidates per check", "minimum": 1, "maximum": 50, "type": "integer", "description": "Caps published candidate rows returned for each contractor. Each candidate is emitted as a separately ranked review row. When this cap is reached, the result stays source-limited rather than making an absence claim.", "default": 10 }, "monitorMode": { "title": "Only emit changed verified records", "type": "boolean", "description": "Save source-scoped snapshots and emit new, field-level updated, or missing-record review signals after complete, uncapped checks. A first absence is a candidate; confirmation requires two consecutive complete checks. Source failures and capped searches never advance the snapshot.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional stable name for this saved verification batch." } } }, "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 } } } } } } } } } }