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.

Phone numbers are returned in E.164 format, for example +33612345678. landlines holds landline and other non-mobile numbers found for the person. Landlines are free of charge: they never use mobile credits and are returned whether or not include.mobile is set. Each number in mobilePhones and landlines carries lineType, its validated line type, when one is known.

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

GET
/v2/people/enrich/{id}

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": [
    {
      "city": "Paris",
      "companyDomain": "surfe.com",
      "companyName": "Surfe",
      "country": "fr",
      "departments": [
        "Engineering",
        "R&D"
      ],
      "email": "david.chevalier@surfe.com",
      "emails": [
        {
          "email": "david.chevalier@surfe.com",
          "emailType": "professional",
          "validationStatus": "VALID"
        }
      ],
      "externalID": "external-id",
      "firstName": "David",
      "found": true,
      "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",
      "landlines": [
        {
          "landline": "+33123456789",
          "lineType": "FIXED_LINE",
          "validationStatus": "VALID"
        }
      ],
      "lastName": "Chevalier",
      "linkedInUrl": "https://www.linkedin.com/in/david-maurice-chevalier",
      "location": "Paris, Île-de-France, France",
      "mobilePhones": [
        {
          "confidenceScore": 0.8,
          "lineType": "MOBILE",
          "mobilePhone": "+33612345678"
        }
      ],
      "seniorities": [
        "Manager",
        "Head"
      ],
      "state": "Île-de-France",
      "status": "COMPLETED",
      "toolErrors": [
        {
          "provider": "KASPR",
          "type": "INVALID_API_KEY"
        }
      ]
    }
  ],
  "percentCompleted": 50,
  "status": "string"
}