{ "openapi": "3.0.1", "info": { "title": "Bank Compliance Monitor: Regulator Circulars", "description": "Monitor regulatory updates and regulator circulars for bank compliance: Fed SR letters, OCC bulletins, FDIC letters, FinCEN AML advisories, Central Bank of Jordan (CBJ) circulars and Saudi NCA cybersecurity controls. Topic tags such as AML and cyber. Monitor mode returns only new documents.", "version": "0.1", "x-build-id": "bARom0AHVbqOduBGt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maliksaid~regulator-circulars-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maliksaid-regulator-circulars-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/maliksaid~regulator-circulars-monitor/runs": { "post": { "operationId": "runs-sync-maliksaid-regulator-circulars-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/maliksaid~regulator-circulars-monitor/run-sync": { "post": { "operationId": "run-sync-maliksaid-regulator-circulars-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", "properties": { "sources": { "title": "Regulators", "type": "array", "description": "Which regulators to read. Leave empty to read all six.", "items": { "type": "string", "enum": [ "cbj", "nca", "fed", "occ", "fdic", "fincen" ], "enumTitles": [ "Central Bank of Jordan (circulars)", "Saudi National Cybersecurity Authority (regulatory documents)", "US Federal Reserve Board (SR and CA letters)", "US Office of the Comptroller of the Currency (bulletins)", "US FDIC (financial institution letters)", "US FinCEN (AML advisories)" ] }, "default": [ "cbj", "nca", "fed", "occ", "fdic", "fincen" ] }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only documents whose title, reference, type or regulator contains at least one keyword. English keywords match whole words. Arabic keywords match anywhere in a word. Leave empty to keep every document.", "default": [], "items": { "type": "string" } }, "topics": { "title": "Topics", "type": "array", "description": "Keep only documents tagged with at least one of these topics. Tags come from simple keyword rules on the title, summary and category. Leave empty to keep every topic.", "items": { "type": "string", "enum": [ "aml", "cybersecurity", "capital", "consumer", "payments", "digital-assets", "fraud", "credit", "governance", "reporting", "supervision", "fx-exchange", "islamic", "climate" ], "enumTitles": [ "AML, sanctions and financial crime", "Cybersecurity and IT risk", "Capital and liquidity", "Consumer protection", "Payments and remittances", "Digital assets and fintech", "Fraud and scams", "Credit and lending", "Governance, risk management and compliance", "Regulatory reporting", "Supervision, examinations and enforcement", "Foreign exchange and money exchange", "Islamic finance", "Climate and sustainability" ] }, "default": [] }, "documentTypes": { "title": "Document types", "type": "array", "description": "Keep only documents whose type contains one of these words, any case. Types today: \"SR letter\", \"CA letter\" and \"supervisory letter\" (Federal Reserve), \"bulletin\" (OCC), \"financial institution letter\" (FDIC), \"advisory\" (FinCEN), \"circular\", \"memo\", \"form\" and \"other\" (CBJ), \"controls\", \"framework or standard\" and \"guideline\" (NCA). Leave empty for every type.", "default": [], "items": { "type": "string" } }, "daysBack": { "title": "Issued in the last (days)", "minimum": 0, "type": "integer", "description": "Keep only documents issued in the last N days. 0 means any date. Uses the issue date, else the publish date. Documents with neither date are kept.", "default": 0 }, "dateFrom": { "title": "Issued from", "type": "string", "description": "Keep documents issued on or after this date (YYYY-MM-DD). Uses the issue date, else the publish date. Documents with neither date are kept." }, "dateTo": { "title": "Issued to", "type": "string", "description": "Keep documents issued on or before this date (YYYY-MM-DD)." }, "countries": { "title": "Countries", "type": "array", "description": "Read only regulators from these countries. Leave empty for all countries.", "items": { "type": "string", "enum": [ "JO", "SA", "US" ], "enumTitles": [ "Jordan", "Saudi Arabia", "United States" ] }, "default": [] }, "monitorMode": { "title": "Monitor mode (only new documents)", "type": "boolean", "description": "Return only documents that earlier monitor-mode runs with the same monitor name did not return. Schedule the Actor with this on to get a feed of new circulars.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Name of the memory that monitor mode uses. Use a different name for each separate watch list. Inputs that still send the old field `stateKey` keep working.", "default": "default" }, "maxItems": { "title": "Maximum documents", "minimum": 0, "type": "integer", "description": "Stop after saving this many documents. The Actor takes them from each regulator in turn, newest first. Set 0 for no limit.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is on by default. The Central Bank of Jordan site does not answer DNS lookups from Apify servers without it.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }