{
  "openapi": "3.0.1",
  "info": {
    "title": "Sanctions Screening Suite: OFAC, EU, UK, UN & PEP Watchlists",
    "description": "All-in-one sanctions screening suite for teams and AI agents. Screen, monitor and export against official OFAC, EU, UK OFSI, UN and OpenSanctions PEP watchlists. Get a CLEAR/REVIEW/ESCALATE verdict, auto-cleared false positives, an audit PDF and crypto-wallet screening. Official data, nothing stored",
    "version": "0.0",
    "x-build-id": "uPs2IOCmG4o7zTBu1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/apifmcpfactory~sanctions-screening/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-apifmcpfactory-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/apifmcpfactory~sanctions-screening/runs": {
      "post": {
        "operationId": "runs-sync-apifmcpfactory-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/apifmcpfactory~sanctions-screening/run-sync": {
      "post": {
        "operationId": "run-sync-apifmcpfactory-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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "screen",
              "monitor",
              "export",
              "list_status",
              "refresh_cache"
            ],
            "type": "string",
            "description": "\"screen\" (default) checks the subjects below. \"monitor\" re-screens subjects against freshly-fetched lists and reports only what changed since a prior run. \"export\" dumps one official/aggregated list as CSV/JSON/XLSX. \"list_status\" shows each list's cached record count and last-refresh date. \"refresh_cache\" force re-fetches all 7 lists (wire to a daily Schedule).",
            "default": "screen"
          },
          "subjects": {
            "title": "Subjects to screen",
            "type": "array",
            "description": "Plain names as strings, or structured objects for richer matching: {\"name\": \"...\", \"entityType\": \"person|org\", \"yearOfBirth\": 1980, \"dob\": \"1980-05-01\", \"country\": \"Cuba\", \"nationality\": \"Cuban\", \"idNumber\": \"...\", \"passport\": \"...\", \"regNumber\": \"...\", \"lei\": \"...\", \"program\": \"IRAN\"}. A crypto address (BTC/ETH/etc. shape) is screened against OFAC's digital currency address list instead of fuzzy name matching. Billed once per non-empty subject via the entity-screened event.",
            "default": [
              "AeroCaribbean Airlines",
              "Acme Test Company"
            ]
          },
          "subjectsText": {
            "title": "Subjects as pasted text (optional)",
            "type": "string",
            "description": "One name per line, or a CSV block with a header row (name,entityType,dob,country,nationality,idNumber,passport,regNumber,lei,program). Merged with \"Subjects to screen\" above if both are given."
          },
          "subjectsFileUrl": {
            "title": "Subjects file URL (optional)",
            "type": "string",
            "description": "A public https URL to a .csv or .xlsx file of subjects (same columns as the pasted-text CSV format above). Merged with the other subject fields if more than one is given."
          },
          "entityType": {
            "title": "Entity type",
            "enum": [
              "any",
              "person",
              "org"
            ],
            "type": "string",
            "description": "Narrow matching to persons or organizations only. \"any\" (default) checks every list entry regardless of type. A per-subject entityType overrides this.",
            "default": "any"
          },
          "threshold": {
            "title": "Match threshold (0-100)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Minimum fuzzy-match score (deterministic, transliteration-aware Jaro-Winkler over normalised names and aliases) for a list entry to be returned as a match. Lower catches more spelling/order/script variants but risks false positives; higher is stricter. Default 85.",
            "default": 85
          },
          "fuzzy": {
            "title": "Fuzzy matching",
            "type": "boolean",
            "description": "When true (recommended), names are matched with typo/spelling/word-order tolerance and Cyrillic/Greek-to-Latin transliteration. When false, only exact (or punctuation-only-different) matches count.",
            "default": true
          },
          "lists": {
            "title": "Lists to screen (optional)",
            "type": "array",
            "description": "Restrict screening to specific lists. Leave empty to screen all 7: OFAC SDN, OFAC Consolidated, EU Consolidated, UK OFSI, UN Consolidated, OpenSanctions Sanctions, OpenSanctions PEP.",
            "items": {
              "type": "string",
              "enum": [
                "OFAC SDN",
                "OFAC Consolidated",
                "EU Consolidated",
                "UK OFSI",
                "UN Consolidated",
                "OpenSanctions Sanctions",
                "OpenSanctions PEP"
              ]
            }
          },
          "whitelist": {
            "title": "Whitelist (optional)",
            "type": "array",
            "description": "Names or list entityIds (e.g. \"OFAC SDN-36\") from prior decisions to suppress. A suppressed match is reported as cleared with reason \"whitelisted (prior decision)\".",
            "items": {
              "type": "string"
            }
          },
          "generateCertificate": {
            "title": "Generate PDF audit certificate",
            "type": "boolean",
            "description": "Renders a one-page-per-subject PDF Sanctions Screening Certificate (lists + versions, method, threshold, verdict, matches) into this run's key-value store. Charged once per run via the pdf-certificate event.",
            "default": false
          },
          "priorRunId": {
            "title": "Prior run ID (optional)",
            "type": "string",
            "description": "The Actor run ID of a previous screen/monitor run to diff against, in monitor mode. Omit to establish the first baseline (nothing to diff against yet)."
          },
          "webhookUrl": {
            "title": "Webhook URL on completion (optional)",
            "type": "string",
            "description": "In monitor mode, if any changes are found, the change list is POSTed as JSON to this URL. You can also wire Apify's own native webhooks to this Actor's run events for the same purpose."
          },
          "exportList": {
            "title": "List to export",
            "enum": [
              "OFAC SDN",
              "OFAC Consolidated",
              "EU Consolidated",
              "UK OFSI",
              "UN Consolidated",
              "OpenSanctions Sanctions",
              "OpenSanctions PEP"
            ],
            "type": "string",
            "description": "Which list to dump, in export mode.",
            "default": "OFAC SDN"
          },
          "exportFormat": {
            "title": "Export format",
            "enum": [
              "csv",
              "json",
              "xlsx"
            ],
            "type": "string",
            "description": "Output format for export mode, written to this run's key-value store under the key \"EXPORT\".",
            "default": "csv"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}