{
"openapi": "3.0.1",
"info": {
"title": "OFAC Sanctions Screener (SDN + Consolidated, Fuzzy Match)",
"description": "Bulk-screen people, companies and vessels against US Treasury OFAC SDN and Consolidated sanctions lists with fuzzy name and alias matching. Match score, programs, addresses, IDs. Also exports any sanctions program as a data feed. No API key.",
"version": "0.1",
"x-build-id": "hp3Go7FhwS3B9G8lD"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/calculating_kitchen_h0b~ofac-sanctions-screener/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-calculating_kitchen_h0b-ofac-sanctions-screener",
"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/calculating_kitchen_h0b~ofac-sanctions-screener/runs": {
"post": {
"operationId": "runs-sync-calculating_kitchen_h0b-ofac-sanctions-screener",
"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/calculating_kitchen_h0b~ofac-sanctions-screener/run-sync": {
"post": {
"operationId": "run-sync-calculating_kitchen_h0b-ofac-sanctions-screener",
"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": [
"screen",
"list"
],
"type": "string",
"description": "screen: one output row per input name with match result and top matches. list: returns the sanctions records themselves (filtered by program, type and country).",
"default": "screen"
},
"names": {
"title": "Names to screen",
"type": "array",
"description": "People, companies, vessels or aircraft to check. Any order and format works (e.g. 'Vladimir Putin' or 'PUTIN, Vladimir'); case, punctuation, diacritics, token order and company legal forms (LLC, Ltd, OOO...) are normalized.",
"items": {
"type": "string"
}
},
"minScore": {
"title": "Match score threshold (0-100)",
"minimum": 50,
"maximum": 100,
"type": "integer",
"description": "Minimum fuzzy similarity score to count as a potential match. 85 is a common screening default; lower it (e.g. 80) to catch more transliteration variants, raise it (e.g. 92) to reduce false positives.",
"default": 85
},
"maxMatchesPerName": {
"title": "Max matches per name",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "How many candidate sanctioned records to return for each screened name, best first.",
"default": 5
},
"matchAlgorithm": {
"title": "Match algorithm",
"enum": [
"token_sort",
"wratio",
"token_set"
],
"type": "string",
"description": "RapidFuzz scorer used to compare normalized names.",
"default": "token_sort"
},
"includeAliases": {
"title": "Match against aliases (a.k.a. / f.k.a. / n.k.a.)",
"type": "boolean",
"description": "Also compare against every alias OFAC publishes for each record. Strongly recommended.",
"default": true
},
"lists": {
"title": "Lists to check",
"type": "array",
"description": "Which OFAC lists to load. Both by default.",
"items": {
"type": "string",
"enum": [
"SDN",
"CONSOLIDATED"
],
"enumTitles": [
"SDN list (Specially Designated Nationals and Blocked Persons)",
"Consolidated non-SDN list (SSI, NS-MBS, FSE, CAPTA, NS-CMIC, PLC...)"
]
},
"default": [
"SDN",
"CONSOLIDATED"
]
},
"entityTypes": {
"title": "Entity type filter",
"type": "array",
"description": "Optional. Only match/return records of these types. Empty = all types.",
"items": {
"type": "string",
"enum": [
"individual",
"entity",
"vessel",
"aircraft"
],
"enumTitles": [
"Individual",
"Entity / organization",
"Vessel",
"Aircraft"
]
}
},
"countries": {
"title": "Country filter",
"type": "array",
"description": "Optional. Only match/return records with an address, nationality, citizenship or vessel flag containing one of these (e.g. Russia, Iran, Venezuela).",
"items": {
"type": "string"
}
},
"programs": {
"title": "Sanctions programs",
"type": "array",
"description": "Optional in screen mode; main filter in list mode. OFAC program codes such as RUSSIA-EO14024, SDGT, IRAN, CUBA, DPRK, CYBER2, VENEZUELA-EO13850, GLOMAG, SDNTK.",
"items": {
"type": "string"
}
},
"maxRecords": {
"title": "List mode: max records",
"minimum": 1,
"maximum": 50000,
"type": "integer",
"description": "Cap on the number of sanctions records returned in list mode.",
"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
}
}
}
}
}
}
}
}
}
}