{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening: EU, UK & US OFAC Lists (Official)", "description": "Screen names of people and companies against the official EU, UK (FCDO) and US OFAC sanctions lists in one run: fuzzy, any-script matching with birth year and country checks, or export and monitor new designations. Lists downloaded fresh at every run.", "version": "0.1", "x-build-id": "Xnb5yn33Xn8fQlr0y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/frenchdatalab~sanctions-screening-eu-uk-ofac/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-frenchdatalab-sanctions-screening-eu-uk-ofac", "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/frenchdatalab~sanctions-screening-eu-uk-ofac/runs": { "post": { "operationId": "runs-sync-frenchdatalab-sanctions-screening-eu-uk-ofac", "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/frenchdatalab~sanctions-screening-eu-uk-ofac/run-sync": { "post": { "operationId": "run-sync-frenchdatalab-sanctions-screening-eu-uk-ofac", "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": { "names": { "title": "Names to screen", "type": "array", "description": "People, companies, vessels… One per line, in any script (Владимир Путин works). One result per name: POTENTIAL_MATCH with the matching list entries, or NO_MATCH.", "items": { "type": "string" } }, "records": { "title": "Names with details (optional)", "type": "array", "description": "Same as above with a type, birth date or year and country per name, which removes most false positives: [{\"name\": \"Vladimir Putin\", \"type\": \"person\", \"birthDate\": \"1952-10-07\", \"country\": \"RU\"}]. type: person, organization, vessel or aircraft. country: ISO code or name." }, "entityType": { "title": "Type of the names", "enum": [ "any", "person", "organization", "vessel", "aircraft" ], "type": "string", "description": "Only compare with list entries of this type (applies to the plain names).", "default": "any" }, "minScore": { "title": "Minimum match score", "minimum": 60, "maximum": 100, "type": "integer", "description": "0–100. 85 (default) catches spelling variants, transliterations and missing middle names; raise to 90–95 for fewer, stronger matches.", "default": 85 }, "maxMatchesPerName": { "title": "Maximum matches per name", "minimum": 1, "maximum": 50, "type": "integer", "description": "Best-scoring list entries returned for each name.", "default": 10 }, "includeWeakAliases": { "title": "Include low-quality aliases", "type": "boolean", "description": "Aliases the authorities flag as weak (short or generic). Kept by default with a 10-point penalty; untick to ignore them.", "default": true }, "lists": { "title": "Sanctions lists", "uniqueItems": true, "type": "array", "description": "Official lists, downloaded fresh at every run.", "items": { "type": "string", "enum": [ "EU", "UK", "OFAC-SDN", "OFAC-CONS" ], "enumTitles": [ "EU Consolidated Financial Sanctions List", "UK Sanctions List (FCDO)", "US OFAC SDN List", "US OFAC Consolidated (non-SDN) List" ] }, "default": [ "EU", "UK", "OFAC-SDN", "OFAC-CONS" ] }, "exportEntries": { "title": "Export list entries (instead of screening)", "type": "boolean", "description": "Download the entries of the selected lists in one clean schema (names, aliases, birth dates, nationalities, identifiers, programmes…).", "default": false }, "exportTypes": { "title": "Entry types to export", "uniqueItems": true, "type": "array", "description": "Leave empty for all.", "items": { "type": "string", "enum": [ "person", "organization", "vessel", "aircraft" ], "enumTitles": [ "People", "Companies & organisations", "Vessels", "Aircraft" ] } }, "listedSince": { "title": "Listed since", "type": "string", "description": "Only entries designated on or after this date (EU and UK publish listing dates; OFAC does not: use the option below)." }, "onlyNewSinceLastRun": { "title": "Only changes since the last run", "type": "boolean", "description": "Monitoring: schedule the Actor and get only new designations (change = added) and delistings (change = removed). The first run saves the baseline and returns nothing.", "default": false }, "maxResults": { "title": "Maximum exported entries", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Export mode only.", "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 } } } } } } } } } }