{
  "openapi": "3.0.1",
  "info": {
    "title": "B2B Lead Verifier 🕵️ (registry, insolvency, sanctions)",
    "description": "Check a B2B lead list against the official company registers of France, the UK and Germany: legal entity (SIREN, company number, HRB), still trading or in insolvency, a sanctions screen against OFAC/UN/EU/UK lists, and a confidence score that shows its workings. No API key. Platform usage included.",
    "version": "0.1",
    "x-build-id": "x9AUSADdceZUlEbrc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tagadanar~b2b-lead-verifier/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tagadanar-b2b-lead-verifier",
        "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/tagadanar~b2b-lead-verifier/runs": {
      "post": {
        "operationId": "runs-sync-tagadanar-b2b-lead-verifier",
        "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/tagadanar~b2b-lead-verifier/run-sync": {
      "post": {
        "operationId": "run-sync-tagadanar-b2b-lead-verifier",
        "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": {
          "leads": {
            "title": "Leads to verify",
            "type": "array",
            "description": "Your lead list. Each entry can be a plain company name, or an object with any of <code>companyName</code>, <code>country</code>, <code>city</code>, <code>postalCode</code>, <code>registrationNumber</code> (SIREN/SIRET, UK company number or HRB), <code>domain</code>, <code>email</code>, <code>address</code>, <code>contactName</code>. A town or a postcode makes the match far more reliable when several companies share a name. Output from our lead scrapers can be pasted in as-is."
          },
          "leadsDatasetId": {
            "title": "…or an Apify dataset ID",
            "type": "string",
            "description": "Verify the output of another run instead of pasting it. Paste the dataset ID of any lead scraper run (Google Maps, Europages, Yellow Pages, our own lead actors). Company name, town and country are picked up automatically from the usual field names."
          },
          "leadsCsvUrl": {
            "title": "…or a link to a CSV file",
            "type": "string",
            "description": "A public, direct link to a CSV export from your CRM. The header row names the columns; comma and semicolon files both work. Columns such as <code>company</code>, <code>country</code>, <code>city</code>, <code>zip</code>, <code>website</code> are recognised automatically."
          },
          "defaultCountry": {
            "title": "Country to assume when a lead does not say",
            "enum": [
              "",
              "FR",
              "GB",
              "DE"
            ],
            "type": "string",
            "description": "Used only for leads with no country of their own and no clue in their domain, email or registration number. Leave empty to report those leads as \"country unknown\" rather than guess.",
            "default": ""
          },
          "minMatchScore": {
            "title": "Minimum name-match score to accept",
            "minimum": 70,
            "maximum": 100,
            "type": "integer",
            "description": "How close a registered legal name has to be to your lead name before we call it a match, from 70 (loose) to 100 (the exact legal name only). 82 keeps \"Decathlon France\" matching \"DECATHLON FRANCE SAS\" while rejecting look-alikes in another town.",
            "default": 82
          },
          "checkInsolvency": {
            "title": "Check insolvency registers",
            "type": "boolean",
            "description": "Look every matched company up in BODACC (France), The Gazette (UK) and Insolvenzbekanntmachungen (Germany) to see whether it is in a collective procedure, liquidation or administration. Adds about one second per lead.",
            "default": true
          },
          "screenSanctions": {
            "title": "Screen against sanctions lists",
            "type": "boolean",
            "description": "Screen every company and its directors against the OFAC SDN, UN, EU, UK OFSI and US Consolidated Screening lists, downloaded fresh from the official sources on every run. Adds about fifteen seconds once per run, then nothing per lead.",
            "default": true
          },
          "companiesHouseApiKey": {
            "title": "Your Companies House API key (optional)",
            "type": "string",
            "description": "UK leads work without this: we fall back to the free public company search on GOV.UK. Supplying your own key (free from <a href='https://developer.company-information.service.gov.uk/' target='_blank'>developer.company-information.service.gov.uk</a>) adds SIC codes and richer status data. The key is yours, is never stored, and we never charge you for Companies House lookups."
          },
          "maxLeads": {
            "title": "Maximum leads to verify",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after this many leads. Use it to cap what a run can cost.",
            "default": 1000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}