Enrich Companies (start)

Starts bulk enrichment of the provided list of company domains and returns an enrichment ID.

Enrichment runs asynchronously. To be notified when the enrichments are complete, we highly recommend using the notificationOptions.webhookUrl field. This enables webhook notifications that automatically send the result to your server when ready. For more details, see the webhook documentation here.

Alternatively, you can manually check the enrichment's progress and results by sending a request to GET /v2/companies/enrich/:id. However, polling is less efficient and may introduce delays or unnecessary load.

curl -X POST "https://api.surfe.com/v2/companies/enrich" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "companies": [
      {
        "domain": "surfe.com",
        "externalID": "external-id"
      }
    ],
    "notificationOptions": {
      "webhookUrl": ""
    }
  }'

{
  "enrichmentCallbackURL": "https://api.surfe.com/v2/companies/enrich/0195be44-1a0d-718a-967b-042c9d17ffd7",
  "enrichmentID": "0195be44-1a0d-718a-967b-042c9d17ffd7",
  "message": "Your enrichment has started ✨, estimated time: 2 seconds."
}