Surfe API
SupportGive feedback

(Deprecated) Enrich Contact (get)

Deprecated endpoint

Please use endpoint GET /v1/people/enrichments/:id instead. The behaviour of the endpoint is the same, only the endpoint's URL has changed.

Quota limitation

Results received from this endpoint count towards the contact 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.
The enrichment might take a few seconds to complete, we recommend polling this endpoint around once every second until a status other than IN_PROGRESS is received.

GET
/v1/enrichments/{id}

Authorization

AuthorizationRequiredBearer <token>

In: header

Path Parameters

idRequiredstring

Enrichment ID

curl -X GET "https://api.surfe.com/v1/enrichments/<string>" \
  -H "Authorization: Bearer <token>"

Enriched person

{
  "clientID": "DEPRECATED",
  "companyID": "DEPRECATED",
  "companyName": "ACME corp",
  "companyWebsite": "www.acme.org",
  "country": "United States",
  "departments": [
    "Engineering",
    "R&D"
  ],
  "emails": [
    {
      "email": "janedoe@acme.org",
      "validationStatus": "VALID"
    }
  ],
  "errors": [
    {
      "error": "Not enough mobile phone enrichment credits",
      "type": "NOT_ENOUGH_MOBILE_PHONE_CREDITS"
    }
  ],
  "expiresAt": "2025-01-01T12:00:00.000000+00:00",
  "externalID": "external-id",
  "facebookUrl": "https://www.facebook.com/janedoe",
  "firstName": "Jane",
  "id": "unique-id",
  "jobTitle": "Software engineer",
  "landlines": [
    {
      "landline": "555-555-555"
    }
  ],
  "lastName": "Doe",
  "linkedinUrl": "https://www.linkedin.com/in/janedoe/",
  "location": "Arizona",
  "mobilePhones": [
    {
      "confidenceScore": 0.8,
      "mobilePhone": "+123 4567890"
    }
  ],
  "name": "Jane Doe",
  "seniorities": [
    "Manager",
    "Head"
  ],
  "status": "IN_PROGRESS",
  "subdepartments": [
    "Software Development",
    "Product Management"
  ],
  "twitterUrl": "https://www.twitter.com/janedoe"
}

Previous

(Deprecated) Enrich Contact (start) POST