{ "openapi": "3.0.1", "info": { "title": "UK FCA Register Firm Status Monitor (FRN Watchlist)", "description": "FCA Register monitoring for principal firms, partnership and third-party-risk teams: watch FRNs and get events when a firm is cancelled or suspended, permissions change, Appointed Representatives are added or removed, or a disciplinary record appears. Official FCA Register API (free key).", "version": "0.1", "x-build-id": "dWYpdZLbKmqeREj8v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plym-actor-factory~uk-fca-frn-portfolio-status-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plym-actor-factory-uk-fca-frn-portfolio-status-monitor", "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/plym-actor-factory~uk-fca-frn-portfolio-status-monitor/runs": { "post": { "operationId": "runs-sync-plym-actor-factory-uk-fca-frn-portfolio-status-monitor", "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/plym-actor-factory~uk-fca-frn-portfolio-status-monitor/run-sync": { "post": { "operationId": "run-sync-plym-actor-factory-uk-fca-frn-portfolio-status-monitor", "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": [ "frns" ], "properties": { "frns": { "title": "FRNs to watch (example FRNs prefilled — replace with yours)", "type": "array", "description": "FCA Firm Reference Numbers to monitor via official Register API Firm/{FRN}. Digits only (4–8). Individual IRNs (letter forms) are rejected. Invalid entries are skipped with no charge. Not a nationwide dump — only these FRNs are polled.", "default": [ "122702", "311492" ], "items": { "type": "string" } }, "signalGroups": { "title": "Signal groups", "type": "array", "description": "Which change groups to evaluate: status (Authorised/Cancelled/Suspended/gone), permissions (Firm/Permissions fingerprint), appointed_representatives (Firm/AR adds/removes), disciplinary (new DisciplinaryHistory rows). Default: all. Individual IRN is never included.", "default": [ "status", "permissions", "appointed_representatives", "disciplinary" ], "items": { "type": "string" } }, "maxRunSeconds": { "title": "Max run seconds", "minimum": 5, "maximum": 900, "type": "integer", "description": "Wall-clock budget for the run. Large books may need longer budgets or chunked schedules. Respect FCA ~50 req/10s.", "default": 55 }, "maxEvents": { "title": "Max delivered change events", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many unique change events are delivered (does not include RUN_STATUS).", "default": 500 }, "resumeFromCheckpoint": { "title": "Resume from stored checkpoint", "type": "boolean", "description": "If true, resume FRN snapshots and seen event_uids from the default Key-Value Store.", "default": true }, "sourceMode": { "title": "Source mode (set to live for real data)", "enum": [ "fixture", "live" ], "type": "string", "description": "fixture = local/CI / Apify Store daily auto-test default (no network; emits RUN_STATUS only unless emitFixtureDemoEvents=true). live = official FCA Register API — requires fcaEmail + fcaApiKey. Not HTML scrape; not WatchDog/Distos.", "default": "fixture" }, "emitFixtureDemoEvents": { "title": "Emit fixture demo change events", "type": "boolean", "description": "When sourceMode=fixture, if true push fabricated change events from local fixtures (unit/local demos only). Default false so Store daily auto-tests never emit fake FRN events or charge fca-frn-status-event-delivered. Production: leave false and use sourceMode=live. SAMPLE rows only: demo events use placeholder entities (never real companies/IDs), are flagged sample=true / isSample=true, and are NEVER charged. To see them, set Source mode = fixture and put the placeholder IDs 9999901, 9999902, 9999903 in the watchlist.", "default": false }, "fcaEmail": { "title": "FCA Register API email (X-Auth-Email)", "type": "string", "description": "Email used to register on the free FCA Financial Services Register developer portal. Required only when sourceMode=live. Never logged." }, "fcaApiKey": { "title": "FCA Register API key (X-Auth-Key)", "type": "string", "description": "API key from the free FCA Register developer portal. Required only when sourceMode=live. Marked secret; never logged. Not a WatchDog/Distos key." }, "asOfHint": { "title": "as_of hint (YYYY-MM-DD)", "type": "string", "description": "Optional as_of label for events / RUN_STATUS. Does not force a bulk dump." }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "minimum": 0, "type": "number", "description": "Optional soft budget hint for delivered change events. Platform ACTOR_MAX_TOTAL_CHARGE_USD also applies when set." }, "requestPaceMs": { "title": "Request pace (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Minimum delay between outbound FCA HTTP requests. Default 250 ms. Register API ~50 req / 10s; breaches return 429 and block ~1 minute. Raise if you see 429s.", "default": 250 }, "includeIndividualIrn": { "title": "Include Individual IRN (default OFF)", "type": "boolean", "description": "A5 legal default: OFF. This build does not call Individual IRN endpoints even if set true — product stays firm Status / permissions / AR / disciplinary.", "default": false } } }, "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 } } } } } } } } } }