{ "openapi": "3.0.1", "info": { "title": "Canada Federal Corporation Search", "description": "Search the Corporations Canada federal registry for any federally incorporated business by name, corporation number, or 9-digit business number.", "version": "2.0", "x-build-id": "nggHZoqDieNevkqp0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ryanclinton~canada-corporation-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ryanclinton-canada-corporation-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/ryanclinton~canada-corporation-search/runs": { "post": { "operationId": "runs-sync-ryanclinton-canada-corporation-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/ryanclinton~canada-corporation-search/run-sync": { "post": { "operationId": "run-sync-ryanclinton-canada-corporation-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", "required": [ "query" ], "properties": { "query": { "title": "Search Query", "type": "string", "description": "Corporation name, corporation number, or 9-digit business number to search for", "default": "Shopify" }, "status": { "title": "Corporation Status", "enum": [ "", "1", "9", "10", "11" ], "type": "string", "description": "Filter by corporation status", "default": "" }, "governingLegislation": { "title": "Governing Legislation", "enum": [ "", "6", "14", "3", "9", "7", "8", "12", "5", "13" ], "type": "string", "description": "Filter by governing legislation (act)", "default": "" }, "province": { "title": "Province of Registered Office", "enum": [ "", "124-AB", "124-BC", "124-MB", "124-NB", "124-NF", "124-NT", "124-NS", "124-NU", "124-ON", "124-PE", "124-QC", "124-SK", "124-YT" ], "type": "string", "description": "Filter by province where the registered office is located", "default": "" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of results to return (1-100)", "default": 25 }, "jobToBeDone": { "title": "Job To Be Done", "enum": [ "general", "vendor-onboarding", "customer-kyc", "supplier-review", "sales-lead-validation", "investment-screening", "acquisition-target", "nonprofit-review" ], "type": "string", "description": "Reframes the verdict for your workflow. Each job maps the universal recommended action to an APPROVE / REVIEW / REJECT decision plus a review level (none / standard / enhanced), tuned per job. 'investment-screening' and 'acquisition-target' are strict; 'sales-lead-validation' mainly cares whether the company is real and active. Leave as 'general' for the unframed verdict.", "default": "general" }, "analysisProfile": { "title": "Analysis Profile", "enum": [ "verification", "monitoring", "investigation", "compliance", "minimal", "standard", "full", "llm" ], "type": "string", "description": "Job-named output shape. 'verification' = the decision fields for KYC/onboarding (verdict, risk, health, filing, match confidence). 'monitoring' = change events + anomalies + timeline for scheduled watch runs. 'investigation' = the corporate graph, identity chain, and full event timeline. 'compliance' = everything. 'minimal'/'standard'/'full'/'llm' are verbosity levels. Defaults to standard when unset; full/compliance return all fields." }, "outputProfile": { "title": "Output Profile (legacy alias for Analysis Profile)", "enum": [ "minimal", "standard", "full", "llm" ], "type": "string", "description": "Legacy alias for Analysis Profile. Still accepted for back-compatibility; new integrations should use analysisProfile. If both are set, analysisProfile wins." }, "watchlistName": { "title": "Watchlist Name (corporate monitoring)", "type": "string", "description": "Optional. Set a name to enable cross-run monitoring. The actor remembers each corporation between runs and emits temporalSignals (NEW / STATUS-CHANGED / RISK-INCREASED / RISK-DECREASED). Leave blank for a one-off lookup. The first run on a new watchlist marks every record as NEW.", "default": "" } } }, "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 } } } } } } } } } }