{ "openapi": "3.0.1", "info": { "title": "V-Safe — Israeli Company KYB Risk Check", "description": "KYB risk scores for Israeli companies: sanctions, insolvency, adverse media, cyber, registry.", "version": "0.1", "x-build-id": "ELMUev6AwIL9JZWpT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brand_risk~vsafe-kyb-risk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brand_risk-vsafe-kyb-risk", "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/brand_risk~vsafe-kyb-risk/runs": { "post": { "operationId": "runs-sync-brand_risk-vsafe-kyb-risk", "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/brand_risk~vsafe-kyb-risk/run-sync": { "post": { "operationId": "run-sync-brand_risk-vsafe-kyb-risk", "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": { "registrationNumbers": { "title": "Company registration numbers (ח.פ)", "type": "array", "description": "One or more 9-digit Israeli company registration numbers to check. This is the simple path — one risk score per number.", "items": { "type": "string" } }, "companies": { "title": "Companies (advanced)", "type": "array", "description": "Optional richer input. Each item may carry a website / name / cross-walk ids that feed the domain & web-presence layers. Use this instead of (or in addition to) the simple list when you have more than just the registration number.\n\nExample item: {\"registration_number\": \"520013954\", \"website\": \"teva.co.il\"}" }, "tier": { "title": "Tier", "enum": [ "full", "quick" ], "type": "string", "description": "Quick = registry + insolvency + restricted-account + domain. Full = all layers. Applied to every company unless overridden per-item in the advanced list.", "default": "full" }, "apiBaseUrl": { "title": "V-Safe API base URL", "type": "string", "description": "Base URL of the V-Safe REST API. Leave as default unless you were given a different endpoint.", "default": "https://api.v-safe.ai" }, "apiToken": { "title": "V-Safe API token (optional)", "type": "string", "description": "Optional. A V-Safe bearer token (JWT) to authenticate the checks. Leave blank to use the publisher's metered service account — billing then runs through Apify. Only set this if you have your own V-Safe pilot token." }, "requestTimeoutSecs": { "title": "Per-check timeout (seconds)", "minimum": 30, "maximum": 180, "type": "integer", "description": "A live check fans out to primary sources and can take up to ~20s. Keep this at 60 or higher.", "default": 60 }, "maxConcurrency": { "title": "Max concurrent checks", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many companies to check in parallel. Kept low by default to respect upstream rate/cost ceilings.", "default": 1 } } }, "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 } } } } } } } } } }