Enrich People (start)

Quota limitation

This endpoint will not succeed if there is not enough people enrichment quota or credits available

Starts bulk enriching the provided list of people 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/people/enrich/:id. However, polling is less efficient and may introduce delays or unnecessary load.

Looking for V1? It’s deprecated, but still available here.
Single person enrichment is deprecated too. You can learn more here.

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

People to enrich

includeRequiredobject

Include - List of fields to include in the enrichment results. Must have at least one field.

notificationOptionsobject

peopleRequiredarray<object>

People - List of people to enrich. Must contain at least one person and at most 10000. Better find rates can be achieved by providing as much information as possible.

curl -X POST "https://api.surfe.com/v2/people/enrich" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "include": {
      "email": true,
      "linkedInUrl": false,
      "mobile": true
    },
    "notificationOptions": {
      "webhookUrl": ""
    },
    "people": [
      {
        "companyDomain": "surfe.com",
        "companyName": "Surfe",
        "externalID": "external-id",
        "firstName": "David",
        "lastName": "Chevalier",
        "linkedinUrl": "https://www.linkedin.com/in/david-maurice-chevalier"
      }
    ]
  }'

Enrichment ID

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

Enrich People (start)

Authorization

Request Body

Response

TypeScript