{
  "openapi": "3.0.1",
  "info": {
    "title": "Company Screening API - Sanctions, Ownership, Risk",
    "description": "Search a global corporate registry and risk graph for companies, people, vessels and trade entities. Filter by country, entity type, sanctions, export controls, forced labor and adverse media. Pay per result. Bring your own API key.",
    "version": "0.1",
    "x-build-id": "3TugTpRanKdSjJTZc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nabeelbaghoor~company-screening-risk-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nabeelbaghoor-company-screening-risk-api",
        "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/nabeelbaghoor~company-screening-risk-api/runs": {
      "post": {
        "operationId": "runs-sync-nabeelbaghoor-company-screening-risk-api",
        "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/nabeelbaghoor~company-screening-risk-api/run-sync": {
      "post": {
        "operationId": "run-sync-nabeelbaghoor-company-screening-risk-api",
        "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",
            "type": "string",
            "description": "What to search for: a company name, a person name, a registration number, an address or a phone number. Leave empty to search by filters alone."
          },
          "queryFields": {
            "title": "Restrict the query to these fields",
            "type": "array",
            "description": "Limit where the query text is matched. Leave empty to search every field.",
            "items": {
              "type": "string",
              "enum": [
                "name",
                "identifier",
                "address",
                "business_purpose",
                "date_of_birth",
                "contact"
              ],
              "enumTitles": [
                "Name",
                "Identifier",
                "Address",
                "Business purpose",
                "Date of birth",
                "Contact"
              ]
            }
          },
          "advanced": {
            "title": "Advanced query syntax",
            "type": "boolean",
            "description": "Treat the query as an advanced expression, which supports boolean operators, quoted phrases and field-scoped terms. Leave off for a plain keyword search.",
            "default": false
          },
          "entityType": {
            "title": "Entity type",
            "type": "array",
            "description": "Restrict results to these kinds of entity. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "company",
                "person",
                "government_organization",
                "tradename",
                "vessel",
                "aircraft",
                "property",
                "shipment",
                "contract",
                "transaction",
                "account",
                "security",
                "intellectual_property",
                "legal_matter",
                "generic",
                "unknown"
              ],
              "enumTitles": [
                "Company",
                "Person",
                "Government organization",
                "Trade name",
                "Vessel",
                "Aircraft",
                "Property",
                "Shipment",
                "Contract",
                "Transaction",
                "Account",
                "Security",
                "Intellectual property",
                "Legal matter",
                "Generic",
                "Unknown"
              ]
            }
          },
          "country": {
            "title": "Country",
            "type": "array",
            "description": "Countries the entity itself is linked to, as three-letter codes such as USA, CHN, DEU, GBR.",
            "items": {
              "type": "string"
            }
          },
          "sourceCountry": {
            "title": "Source country",
            "type": "array",
            "description": "Countries of the underlying record sources, as three-letter codes. Use this to require evidence from a given jurisdiction.",
            "items": {
              "type": "string"
            }
          },
          "state": {
            "title": "State or province",
            "type": "array",
            "description": "State or province names to match.",
            "items": {
              "type": "string"
            }
          },
          "city": {
            "title": "City",
            "type": "array",
            "description": "City names to match.",
            "items": {
              "type": "string"
            }
          },
          "riskCategory": {
            "title": "Risk category",
            "type": "array",
            "description": "Only return entities carrying a risk signal in these categories.",
            "items": {
              "type": "string",
              "enum": [
                "sanctions",
                "sanctions_and_export_control_lists",
                "export_controls",
                "forced_labor",
                "adverse_media",
                "environmental_risk",
                "political_exposure",
                "regulatory_action"
              ],
              "enumTitles": [
                "Sanctions",
                "Sanctions and export control lists",
                "Export controls",
                "Forced labor",
                "Adverse media",
                "Environmental risk",
                "Political exposure",
                "Regulatory action"
              ]
            }
          },
          "risk": {
            "title": "Risk factor",
            "type": "array",
            "description": "Specific risk factor identifiers to require, for a narrower filter than a whole risk category.",
            "items": {
              "type": "string"
            }
          },
          "source": {
            "title": "Source",
            "type": "array",
            "description": "Restrict matches to these source identifiers, for example a single registry or watchlist.",
            "items": {
              "type": "string"
            }
          },
          "bounds": {
            "title": "Geographic bounds",
            "type": "array",
            "description": "Bounding boxes as north,west,south,east coordinate strings. Only entities with an address inside a box are returned.",
            "items": {
              "type": "string"
            }
          },
          "rawFilter": {
            "title": "Extra filters",
            "type": "object",
            "description": "Any additional filter, merged over the ones above. Values may be a single value or a list. Use this for a filter the provider adds after this actor was published."
          },
          "maxResults": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after this many entity records (1 to 10,000). The provider caps a single search at 10,000 matches. You are charged per result returned."
          },
          "pageSize": {
            "title": "Results per request",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many entities to request per API call (1 to 100). Larger pages mean fewer calls."
          },
          "apiKey": {
            "title": "API client id",
            "type": "string",
            "description": "Your own client id for the data provider. Required. Used with the client secret below to obtain a short-lived access token. Stored securely and never logged."
          },
          "apiSecret": {
            "title": "API client secret",
            "type": "string",
            "description": "Your own client secret for the data provider. Required. Stored securely and never logged."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}