{ "openapi": "3.0.1", "info": { "title": "Counterparty Check API: KYB checklist from official registers", "description": "KYB checklist per company: register status, LEI, insolvency, recent accounts, sanctions (OFAC, UN, UK, EU) on the company and officers, VAT (VIES), IBAN; pass, fail, review or unverified, each sourced. Officers: UK, PL, NO, FR only. Insolvency: UK, PL, FR, DE, NL, NO, FI, EE; elsewhere unverified.", "version": "0.1", "x-build-id": "J5mhtHe0ARMRgguTn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bosco_labs~counterparty-check/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bosco_labs-counterparty-check", "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/bosco_labs~counterparty-check/runs": { "post": { "operationId": "runs-sync-bosco_labs-counterparty-check", "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/bosco_labs~counterparty-check/run-sync": { "post": { "operationId": "run-sync-bosco_labs-counterparty-check", "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": "Company (name or identifier)", "pattern": "^[^\\[\\]{}<>\\r\\n]*$", "type": "string", "description": "The counterparty to check: a name (e.g. \"Novo Nordisk\") or an identifier: LEI (20 characters, e.g. \"724500Y6DUVHQD6OXN27\"), UK company number (\"00445790\", \"SC123456\"), Danish CVR (\"24256790\"), Norwegian org number (\"923609016\"), French SIREN (9 digits, \"552032534\") or SIRET (14 digits, \"55203253400703\"), Finnish Business ID with its dash (\"0112038-9\"), Estonian registry code (8 digits, \"12417834\"), US ticker in capitals or with $ (\"AAPL\", \"$brk.b\"; foreign companies listed in the US resolve to their home country), SEC CIK (\"320193\"). The type is detected from format and check digits; an 8-digit number valid in several registers (UK, Danish CVR, Estonian) is settled by asking them, and `country` decides when given. Required, unless you give a `companies` list instead." }, "country": { "title": "Country (optional)", "pattern": "^\\s*([A-Za-z]{2})?\\s*$", "type": "string", "description": "ISO 3166 alpha-2 country code to disambiguate, e.g. \"DK\", \"GB\", \"NO\", \"FR\", \"FI\", \"EE\", \"NL\", \"US\". With a name it limits the search to that country and, for NO, FR, FI and EE, also searches the national register (most companies there have no LEI); with a number it says which register the number belongs to (e.g. \"GB\" for a UK number without a leading zero, \"EE\" for an Estonian registry code, \"FI\" for a Business ID typed without its dash). Empty = detect from the query." }, "vatNumber": { "title": "EU VAT number (optional)", "pattern": "^[^\\[\\]{}<>\r\n]*$", "type": "string", "description": "The VAT number the counterparty gave you, with its country prefix, e.g. \"DK24256790\". Checked live in VIES (valid or not, registered name) and matched against the register's name and country. Empty = the VAT number the register lists, if any (Estonia, Poland); otherwise the VAT check is unverified." }, "iban": { "title": "IBAN (optional)", "pattern": "^[^\\[\\]{}<>\r\n]*$", "type": "string", "description": "The bank account the counterparty wants to be paid on, e.g. \"DK5000400440116243\". Checked offline: length, layout and ISO 13616 check digits, bank code, and whether its country matches the company's. No bank is contacted, so it does not prove who holds the account." }, "walletAddresses": { "title": "Crypto wallet addresses (optional)", "maxItems": 10, "type": "array", "description": "Wallet addresses the counterparty wants to be paid on, e.g. [\"0x7FF9cFad3877F21d41Da833E2F775dB0569eE3D9\"]. Each is matched exactly against the addresses OFAC lists. At most 10.", "items": { "type": "string", "pattern": "^\\s*\\S{1,128}\\s*$" } }, "companies": { "title": "Companies (batch, optional)", "maxItems": 10, "type": "array", "description": "Check a list of companies in one run instead of `query`: up to 10 companies, each a name or number (\"Tesco PLC\") or an object with the fields above, e.g. [\"Tesco PLC\", {\"query\": \"Novo Nordisk A/S\", \"country\": \"DK\", \"vatNumber\": \"DK24256790\"}, {\"query\": \"00445790\", \"country\": \"GB\"}]. One row per company, priced like a single check ($0.05 per company checked); an ambiguous name, or a company no source knows or that does not answer in time, is a row that costs nothing. Leave `query` empty when you use this." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }