{ "openapi": "3.0.1", "info": { "title": "Sanctions Screening & Denied Party Check (OFAC)", "description": "Sanctions screening and denied party screening against official OFAC, BIS Entity List, UK and EU lists. Calibrated match probability cuts false positives.", "version": "0.1", "x-build-id": "PO3sTAtVNhhX3uqt8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reliable_tools~sanctions-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reliable_tools-sanctions-screening", "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/reliable_tools~sanctions-screening/runs": { "post": { "operationId": "runs-sync-reliable_tools-sanctions-screening", "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/reliable_tools~sanctions-screening/run-sync": { "post": { "operationId": "run-sync-reliable_tools-sanctions-screening", "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": { "parties": { "title": "Parties to screen", "type": "array", "description": "One object per customer, supplier or partner. Only \"name\" is required. Optional: \"type\" (individual, entity, vessel, aircraft), \"country\" (name or ISO code), \"dateOfBirth\" (YYYY-MM-DD or YYYY, for individuals), \"address\", \"idNumber\" (passport, national ID, company registration or IMO number), \"aliases\" (list of other names) and \"reference\" (your own ID, returned as is). Every extra attribute helps clear false positives." }, "names": { "title": "Quick list of names", "type": "array", "description": "Optional shortcut: one name per line, screened with no other attributes. Use \"Parties\" above when you know the country, date of birth or ID, so fewer names end up in review.", "items": { "type": "string" } }, "lists": { "title": "Lists to screen", "type": "array", "description": "Official lists, downloaded fresh from each government source for every run. Leave all selected for a full denied-party screen. The UN Security Council list is not offered: the UN website terms allow its data only for personal, non-commercial use. The EU and UK lists already implement UN Security Council designations.", "items": { "type": "string", "enum": [ "ofac_sdn", "ofac_consolidated", "us_csl", "uk", "eu" ], "enumTitles": [ "US OFAC SDN List", "US OFAC Consolidated (non-SDN) List", "US Consolidated Screening List (BIS Entity List, Denied Persons, Unverified, Military End User, ITAR Debarred, Nonproliferation)", "UK Sanctions List", "EU Consolidated Financial Sanctions List" ] }, "default": [ "ofac_sdn", "ofac_consolidated", "us_csl", "uk", "eu" ] }, "minNameScore": { "title": "Minimum name similarity (0 to 100)", "minimum": 70, "maximum": 100, "type": "integer", "description": "How close a listed name must be to become a candidate. Lower finds more spelling variants and more noise; 85 is a good balance.", "default": 85 }, "maxCandidatesPerParty": { "title": "Max candidates per party", "minimum": 1, "maximum": 25, "type": "integer", "description": "The closest listed names per party that get the full attribute check.", "default": 8 }, "likelyMatchThreshold": { "title": "Likely match from probability", "enum": [ "0.6", "0.7", "0.75", "0.8", "0.9" ], "type": "string", "description": "A candidate at or above this probability of being the same party is marked likely_match.", "default": "0.75" }, "reviewThreshold": { "title": "Review from probability", "enum": [ "0.05", "0.1", "0.2", "0.3", "0.4" ], "type": "string", "description": "Candidates between this value and the likely match value go to review. Exact name matches with nothing to rule them out always go to review. Lower is more cautious.", "default": "0.2" } } }, "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 } } } } } } } } } }