{ "openapi": "3.0.1", "info": { "title": "OFAC Sanctions Screening: SDN and Consolidated Lists", "description": "Screen names against the live US Treasury OFAC sanctions lists, SDN plus the Consolidated non-SDN lists, with alias, transliteration and typo matching and the exact list edition on every row. Measured: 100 percent recall on known designations, zero false positives on 200 real businesses.", "version": "0.0", "x-build-id": "Nrc4XmyvpzqyqJJ1B" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thoob~ofac-sanctions-screening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thoob-ofac-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/thoob~ofac-sanctions-screening/runs": { "post": { "operationId": "runs-sync-thoob-ofac-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/thoob~ofac-sanctions-screening/run-sync": { "post": { "operationId": "run-sync-thoob-ofac-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", "required": [ "names" ], "properties": { "names": { "title": "Names to screen", "type": "array", "description": "The person or company names to screen against the OFAC lists. Your list is screened and returned, and is not retained after the run.", "items": { "type": "string" } }, "includeConsolidated": { "title": "Include the non-SDN consolidated lists", "type": "boolean", "description": "Screen against the Consolidated list (FSE, SSI, NS-MBS and others) in addition to the Specially Designated Nationals list. Leave on for broader coverage. Every row states which lists it was actually screened against.", "default": true }, "enrichWithLei": { "title": "Enrich matched companies with their LEI", "type": "boolean", "description": "For a matched company, look up its Legal Entity Identifier in the official GLEIF register. Only runs for a name that already matched, so a clean list costs no extra time. The check is strict and the hit rate is low, about 2 in 60 on a sample of real designations, because OFAC publishes long official forms that no register lists verbatim. A blank LEI means no record was confirmed, never a guess.", "default": true }, "subjectType": { "title": "Subject type", "enum": [ "Entity", "Individual" ], "type": "string", "description": "Tells the matcher whether these names are people or companies. Company names have corporate suffixes like LLC and GmbH folded away before comparison; personal names do not. Leave unset to treat them as companies, which is the safer default.", "default": "Entity" }, "matchThreshold": { "title": "Match threshold", "minimum": 60, "maximum": 100, "type": "integer", "description": "Similarity below which a name is reported clear, as a percentage. Lower catches more spelling and transliteration variants and returns more possible hits to review. 84 is the tuned default; going far below it produces noise, and going far above it starts missing real variants.", "default": 84 }, "maxNames": { "title": "Max names screened", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Safety cap on how many names this run screens and bills, so a first run's cost is predictable. Names past the cap are returned free in the rejected dataset with reason cap_reached, never silently dropped. Set 0 for no cap.", "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 } } }, "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 } } } } } } } } } }