{
  "openapi": "3.0.1",
  "info": {
    "title": "Sanctions & Watchlist Screening — Risk-Scored Decisions",
    "description": "Screen names against OFAC, EU, UN, UK sanctions, PEP and watchlist data via OpenSanctions and get a risk-scored decision per match: block, escalate, review, or clear, with the evidence, review priority, and change monitoring. Batch screening and ongoing watchlist monitoring built in.",
    "version": "2.0",
    "x-build-id": "4C1hWRUnqN1KnleKD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ryanclinton~opensanctions-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ryanclinton-opensanctions-search",
        "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/ryanclinton~opensanctions-search/runs": {
      "post": {
        "operationId": "runs-sync-ryanclinton-opensanctions-search",
        "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/ryanclinton~opensanctions-search/run-sync": {
      "post": {
        "operationId": "run-sync-ryanclinton-opensanctions-search",
        "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": [
          "query"
        ],
        "properties": {
          "apiKey": {
            "title": "OpenSanctions API Key",
            "type": "string",
            "description": "API key from opensanctions.org. Sign up at https://www.opensanctions.org/account/ for a free trial key. Without a key, the actor runs in dry-run mode."
          },
          "query": {
            "title": "Search Query",
            "type": "string",
            "description": "Name or entity to screen (e.g., 'Putin', 'Bank of Syria'). For multiple names in one run, use 'Batch Queries' instead.",
            "default": "Putin"
          },
          "queries": {
            "title": "Batch Queries",
            "maxItems": 500,
            "type": "array",
            "description": "Screen multiple names in one run. Each entry is screened independently and gets its own screening decision + ID; a batch-summary record rolls up the whole run. Overrides the single Search Query when set. Maps a CSV name column straight onto a screening run.",
            "items": {
              "type": "string"
            }
          },
          "entityType": {
            "title": "Entity Type",
            "enum": [
              "Thing",
              "Person",
              "Organization",
              "Company",
              "LegalEntity",
              "Vessel",
              "Airplane",
              "CryptoWallet"
            ],
            "type": "string",
            "description": "Filter by entity type. 'Thing' matches all types.",
            "default": "Thing"
          },
          "country": {
            "title": "Country Filter",
            "pattern": "^[A-Za-z]{2}$",
            "type": "string",
            "description": "Two-letter ISO country code to filter results (e.g., 'RU', 'IR', 'KP', 'SY')"
          },
          "dataset": {
            "title": "Dataset / Scope",
            "enum": [
              "default",
              "sanctions",
              "peps",
              "us_ofac_sdn",
              "eu_fsf",
              "un_sc_sanctions",
              "gb_hmt_sanctions",
              "ca_dfatd_sema_sanctions",
              "au_dfat_sanctions"
            ],
            "type": "string",
            "description": "OpenSanctions dataset to search. 'default' includes all sanctions and PEPs. Use 'sanctions' for sanctions only, or a specific source like 'us_ofac_sdn'.",
            "default": "default"
          },
          "topics": {
            "title": "Topics Filter",
            "enum": [
              "",
              "sanction",
              "role.pep",
              "crime",
              "debarment",
              "role.rca"
            ],
            "type": "string",
            "description": "Filter by topic: 'sanction' for sanctioned entities, 'role.pep' for politically exposed persons, 'crime' for criminal records, 'debarment' for debarred entities",
            "default": ""
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Maximum number of results to return (max 200)",
            "default": 50
          },
          "minMatchScore": {
            "title": "Minimum Match Score",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Drop weak name matches below this OpenSanctions relevance score (0-100, e.g. 70). Suppressed matches are excluded from output AND billing; the suppressed count is reported in the summary. Leave at 0 to keep all matches.",
            "default": 0
          },
          "outputProfile": {
            "title": "Output Detail",
            "enum": [
              "minimal",
              "standard",
              "full"
            ],
            "type": "string",
            "description": "How much detail per match. 'minimal' = routing fields only (risk, action, tier). 'standard' = adds reasoning, confidence, and list coverage. 'full' = every raw OpenSanctions field.",
            "default": "standard"
          },
          "watchlistName": {
            "title": "Watchlist Name (ongoing monitoring)",
            "type": "string",
            "description": "Optional. Name this screen to turn on cross-run monitoring: re-running the same query under the same watchlist name flags each match as NEW / ESCALATED / DOWNGRADED / UNCHANGED / RESOLVED, reports a changeReason and risk delta, tracks how long each entity has been monitored, and remembers your review decisions. Leave blank for a one-off screen."
          },
          "subjectDob": {
            "title": "Subject Date of Birth (corroboration)",
            "type": "string",
            "description": "Optional. The date of birth (YYYY-MM-DD) of the person you are screening. Used only to corroborate matches (matchEvidence.dobMatch) — it does not filter results. Helps reviewers cut false positives on common names."
          },
          "subjectIdentifier": {
            "title": "Subject Identifier (corroboration)",
            "type": "string",
            "description": "Optional. A passport / tax / registration number of the subject. Used only to corroborate matches (matchEvidence.identifierMatch). A match here is the strongest disambiguation signal."
          },
          "reviewDecisions": {
            "title": "Review Decisions (case management)",
            "type": "array",
            "description": "Watchlist mode only. Record analyst decisions on matches so they persist across runs: an array of { \"openSanctionsId\": \"...\", \"status\": \"false-positive\" | \"confirmed-match\" | \"pending-review\" | \"unreviewed\", \"reviewedBy\": \"analyst@example.com\" (optional), \"reviewReason\": \"DOB mismatch\" (optional) }. On the next run each match carries its remembered reviewStatus, reviewedBy, reviewReason, reviewedAt and full caseHistory — a lightweight compliance case file."
          },
          "suppressFalsePositives": {
            "title": "Suppress Known False Positives",
            "type": "boolean",
            "description": "Watchlist mode only. Drop entities you previously marked 'false-positive' from the output (they are counted, never silently lost, and feed the analyst-time-saved estimate). Cuts repeat review work on recurring screens.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}