Enrich People (get)

Quota limitation

Results received from this endpoint count towards the people enrichment quota and will consume credits

Provide an enrichment ID and the endpoint will return the corresponding enrichment's progress. Once it is completed, the response will also include the enrichment results.

Enrichments may take a few seconds to complete. We recommend subscribing to the person.enrichment.completed webhook event, documented here, to be notified automatically when the process finishes. Alternatively, you can poll this endpoint approximately once per second until the status changes from IN_PROGRESS.

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

Authorization

AuthorizationRequiredBearer <token>

In: header

Path Parameters

idRequiredstring

Enrichment ID from where to retrieve the results.

curl -X GET "https://api.surfe.com/v2/people/enrich/<your-enrichment-id>" \
  -H "Authorization: Bearer <token>"

List of enriched people

{
  "enrichmentID": "enrichment-id",
  "people": [
    {
      "companyDomain": "surfe.com",
      "companyName": "Surfe",
      "country": "France",
      "departments": [
        "Engineering",
        "R&D"
      ],
      "emails": [
        {
          "email": "david.chevalier@surfe.com",
          "validationStatus": "VALID"
        }
      ],
      "externalID": "external-id",
      "firstName": "David",
      "jobHistory": [
        {
          "companyName": "Surfe",
          "endDate": "2023-01-01T00:00:00Z",
          "jobTitle": "Co-Founder & CEO",
          "linkedInURL": "urn:li:company:123456",
          "startDate": "2023-01-01T00:00:00Z"
        }
      ],
      "jobTitle": "Co-Founder & CEO",
      "lastName": "Chevalier",
      "linkedInUrl": "https://www.linkedin.com/in/david-maurice-chevalier",
      "location": "Paris, Île-de-France",
      "mobilePhones": [
        {
          "confidenceScore": 0.8,
          "mobilePhone": "+33 6 12 34 56 78"
        }
      ],
      "seniorities": [
        "Manager",
        "Head"
      ],
      "status": "COMPLETED"
    }
  ],
  "percentCompleted": 50,
  "status": "IN_PROGRESS"
}

Enrich People (get)

Authorization

Path Parameters

Response

TypeScript