{
  "openapi": "3.0.1",
  "info": {
    "title": "OFAC Sanctions List Search — SDN Screening with Fuzzy Matching",
    "description": "Screen names against the US Treasury OFAC SDN sanctions list and get a decision, not just rows: a clear / potential-match / likely-match verdict per subject, plus false-positive resolution that explains why a hit is NOT the sanctioned person. Batch screening, watchlist monitoring, no API key.",
    "version": "1.1",
    "x-build-id": "G1vgZ2YtzgBLde4wi"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/ryanclinton~ofac-sanctions-search/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-ryanclinton-ofac-sanctions-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~ofac-sanctions-search/runs": {
      "post": {
        "operationId": "runs-sync-ryanclinton-ofac-sanctions-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~ofac-sanctions-search/run-sync": {
      "post": {
        "operationId": "run-sync-ryanclinton-ofac-sanctions-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",
        "properties": {
          "query": {
            "title": "Search Query (single subject)",
            "type": "string",
            "description": "One name, entity, vessel, or ID number to screen. For multiple subjects use Subjects or Subjects (text) below."
          },
          "subjects": {
            "title": "Subjects (batch)",
            "maxItems": 5000,
            "type": "array",
            "description": "Screen many subjects in one run. Array of objects: { \"name\": string, \"aliases\"?: string[], \"idNumber\"?: string, \"dateOfBirth\"?: string, \"yearOfBirth\"?: number, \"country\"?: string, \"program\"?: string, \"searchType\"?: string }. Aliases are screened under the same subject; idNumber is matched against the SDN ID documents. The SDN list is downloaded once and every subject is screened against it."
          },
          "subjectsText": {
            "title": "Subjects (text, one per line)",
            "type": "string",
            "description": "Paste a list of names, one per line. The simplest way to batch-screen a customer list."
          },
          "runMode": {
            "title": "Run Mode",
            "enum": [
              "screen",
              "monitor",
              "lookup"
            ],
            "type": "string",
            "description": "screen = normal decisioning (default); monitor = with a watchlist, emit only subjects that changed since last run; lookup = exact UID / ID / name resolution (no fuzzy matching).",
            "default": "screen"
          },
          "subjectId": {
            "title": "Subject ID (single subject)",
            "type": "string",
            "description": "Stable identifier echoed on every output record so downstream systems join on an ID, not a name. For batch, set per subject inside the Subjects array."
          },
          "externalReference": {
            "title": "External Reference (single subject)",
            "type": "string",
            "description": "KYC case / transaction / CRM reference echoed on every output record. For batch, set per subject inside the Subjects array."
          },
          "searchType": {
            "title": "Entity Type",
            "enum": [
              "All",
              "Individual",
              "Entity",
              "Vessel",
              "Aircraft"
            ],
            "type": "string",
            "description": "Restrict screening to one SDN entry type.",
            "default": "All"
          },
          "program": {
            "title": "Sanctions Program",
            "type": "string",
            "description": "Filter by sanctions program code (e.g. SDGT, IRAN, UKRAINE-EO13662, CUBA, DPRK, SYRIA)."
          },
          "country": {
            "title": "Subject Country",
            "type": "string",
            "description": "The subject's known country. Used to corroborate matches: a country mismatch becomes a negative (different-person) signal. It does NOT filter results out -- a screening tool should never hide a potential hit listed under a different country."
          },
          "dateOfBirth": {
            "title": "Date of Birth (false-positive reduction)",
            "type": "string",
            "description": "Subject's date of birth (YYYY or a full date). When provided, individual matches are corroborated against the SDN entry's known DOBs — a conflicting year downgrades a name match as a likely false positive."
          },
          "yearOfBirth": {
            "title": "Year of Birth",
            "minimum": 1000,
            "maximum": 2100,
            "type": "integer",
            "description": "Subject's year of birth, if the full date is unknown. Same false-positive-reduction effect as Date of Birth."
          },
          "fuzzyMatch": {
            "title": "Fuzzy Matching",
            "type": "boolean",
            "description": "Enable fuzzy/partial name matching (catches spelling and transliteration variants). When disabled, requires an exact substring match.",
            "default": true
          },
          "maxResults": {
            "title": "Max Matches per Subject",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum number of matching SDN entries returned per subject.",
            "default": 50
          },
          "screeningProfile": {
            "title": "Screening Profile",
            "enum": [
              "conservative",
              "balanced",
              "aggressive",
              "investigative"
            ],
            "type": "string",
            "description": "Preset posture that sets the thresholds and fuzzy matching for you. conservative = fewest false positives; balanced = default; aggressive = maximum detection; investigative = surfaces weak matches for analyst review. Explicit thresholds below override the profile."
          },
          "reviewThreshold": {
            "title": "Review Threshold",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Match score (0-100) at or above which a result counts as a potential match worth reviewing. Overrides the screening profile."
          },
          "hitThreshold": {
            "title": "Hit Threshold",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Match score (0-100) at or above which a result is treated as a likely match (escalate for review). Overrides the screening profile."
          },
          "watchlistName": {
            "title": "Watchlist Name (ongoing monitoring)",
            "type": "string",
            "description": "Name a watchlist to track screening results across scheduled runs. Each subject then carries a change flag (new-hit / cleared / still-hit / unchanged) so you are alerted when a previously-clear subject is newly sanctioned. First run flags every subject as 'new'; change detection activates from the second run."
          },
          "expandNameVariants": {
            "title": "Expand Name Variants",
            "type": "boolean",
            "description": "Also screen common transliteration and corporate-suffix variants of each name (e.g. Muhammad / Mohammed, Ltd / Limited) to boost recall on transliterated names.",
            "default": false
          },
          "deduplicateSubjects": {
            "title": "Deduplicate Subjects",
            "type": "boolean",
            "description": "Collapse duplicate subject names before screening (useful for messy customer lists).",
            "default": false
          },
          "includeRejected": {
            "title": "Include Rejected Candidates (debug)",
            "type": "boolean",
            "description": "Emit up to 5 near-miss candidates per subject that were cut from the returned matches, with the reason. Useful for investigators auditing why something did or did not match.",
            "default": false
          },
          "outputProfile": {
            "title": "Output Profile",
            "enum": [
              "minimal",
              "standard",
              "full",
              "investigator"
            ],
            "type": "string",
            "description": "minimal = one verdict record per subject (no entry detail); standard = verdict + lean match rows; full = verdict + complete match rows; investigator = full rows plus the explanation/evidence breakdown on every match.",
            "default": "standard"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}