{ "openapi": "3.0.1", "info": { "title": "UK Visa Sponsor Register – Skilled Worker Sponsors & New Adds", "description": "Search, verify and monitor the official UK Home Office register of licensed visa sponsors (Skilled Worker, GBM, Creative, Student). Filter by name, town, route and A/B rating, fuzzy-match your company list, or get newly added sponsors. $0.80 per 1,000.", "version": "0.1", "x-build-id": "EnKuRvhqSMbgqtw6w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gazidev~uk-visa-sponsor-register/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gazidev-uk-visa-sponsor-register", "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/gazidev~uk-visa-sponsor-register/runs": { "post": { "operationId": "runs-sync-gazidev-uk-visa-sponsor-register", "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/gazidev~uk-visa-sponsor-register/run-sync": { "post": { "operationId": "run-sync-gazidev-uk-visa-sponsor-register", "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": { "mode": { "title": "Mode", "enum": [ "search", "verify" ], "type": "string", "description": "Search returns sponsors that match your filters. Verify checks your own list of employer names against the register and tells you which ones hold a sponsor licence.", "default": "search" }, "register": { "title": "Register", "enum": [ "workers", "students" ], "type": "string", "description": "Which Home Office register of licensed sponsors to use.", "default": "workers" }, "nameContains": { "title": "Organisation name contains", "type": "string", "description": "Case-insensitive, punctuation-insensitive, e.g. `software`, `nhs`, `care`, `university`." }, "towns": { "title": "Town / city", "type": "array", "description": "Exact town/city names as published (case-insensitive), e.g. `London`, `Manchester`, `Birmingham`.", "items": { "type": "string" } }, "counties": { "title": "County", "type": "array", "description": "Exact county (case-insensitive), e.g. `Surrey`, `West Midlands`, `Kent`. Note: many register rows have no county.", "items": { "type": "string" } }, "routes": { "title": "Visa route contains", "type": "array", "description": "Keep sponsors licensed for a route containing this text, e.g. `Skilled Worker`, `Global Business Mobility`, `Creative Worker`, `Charity Worker`, `Scale-up`, `Student`.", "items": { "type": "string" } }, "sponsorTypes": { "title": "Sponsor type", "type": "array", "description": "Exact type (case-insensitive). Workers register: `Worker` or `Temporary Worker`. Students register: e.g. `Independent school`, `Higher Education Institution (HEI)`.", "items": { "type": "string" } }, "ratings": { "title": "Rating / status starts with", "type": "array", "description": "Workers: `A` (includes A Premium / SME+), `B` (B-rated sponsors are on an action plan) or `Provisional`. Students: e.g. `Student Sponsor`, `Probationary`.", "items": { "type": "string" } }, "groupByOrganisation": { "title": "One row per organisation", "type": "boolean", "description": "Merge the register's one-row-per-route lines into one row per organisation (name + town + county) with a `routes` list. Turn off to get the raw register lines.", "default": true }, "onlyNew": { "title": "Only changes since the last run (monitor)", "type": "boolean", "description": "Compare with a snapshot saved by your previous run (same *State key*) and output only sponsors that were added (and optionally removed / changed). The first run only saves the baseline and outputs nothing. Schedule daily.", "default": false }, "changeTypes": { "title": "Changes to report", "type": "array", "description": "Used with *Only changes since the last run*. Filters above also apply.", "items": { "type": "string", "enum": [ "added", "removed", "changed" ], "enumTitles": [ "Added (newly licensed)", "Removed (licence revoked, surrendered or expired)", "Changed (route or rating changed, e.g. A -> B)" ] }, "default": [ "added" ] }, "stateKey": { "title": "State key", "type": "string", "description": "Separate snapshots for separate monitors.", "default": "default" }, "companyNames": { "title": "Company names to verify", "type": "array", "description": "Employer names to check against the register (mode = verify). Legal suffixes (Ltd, Limited, PLC, LLP...) and punctuation are ignored.", "items": { "type": "string" } }, "companiesDatasetId": { "title": "...or company names from a dataset", "type": "string", "description": "Verify names from another Actor's output (e.g. a job-board scraper). In an integration use {{resource.defaultDatasetId}}." }, "datasetNameField": { "title": "Dataset field with the company name", "type": "string", "description": "Auto-detected if empty (companyName, company, organisationName, name, employerName...)." }, "minMatchScore": { "title": "Minimum match score (0-100)", "minimum": 0, "maximum": 100, "type": "integer", "description": "100 = identical after normalisation. Lower values find more spelling variants but may produce false matches. Only matched names are charged.", "default": 88 }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many charged rows (0 = all matching; the full workers register is ~128,000 organisations). You pay per sponsor row saved.", "default": 1000 } } }, "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 } } } } } } } } } }