Enrich Person

Endpoint

This endpoint returns a person object model. The person is identified by one of the following identifiers: id, email, phone, or linkedInUrl. Only one person is returned by this endpoint.

• URL: https://api.profileapi.com/2024-03-01/persons/enrich
• HTTP Method: GET

Request

Parameters

To enrich a person, specify one of the following identifiers: id, email, phone, or linkedInUrl.

Id

• Key: id
• Data Type: uuid
• Description: A universally unique identifier (UUID) compliant with RFC 4122, used to uniquely identify a person. Presented without hyphens.
• Example: "9e6a55b258ef11edb8780242ac120002"

Email

• Key: email
• Data Type: email
• Description: Represents an email address, conforming to the standard format defined in RFC 5322.
• Example: [email protected]

Phone

• Key: phone
• Data Type: phone
• Description: Represents a phone number formatted according to the E.164 international numbering standard.
• Example: +1234567890

LinkedIn URL

• Key: linkedInUrl
• Data Type: url
• Description: URL to a LinkedIn profile.
• Format: https://linkedin.com/in/[handle]
• Example: https://linkedin.com/in/joedoe

important

Only one of the identifiers is allowed.

Fields To Return

• Key: fieldsToReturn
• Data Type: string
• Description: Specifies which set of fields to return in the response.
• Options:

Name	Default	Credits	Description
email	false	1	Return only the person's email.
phone	false	5	Return only the person's phone number.
basic	true	1	Return basic person fields (e.g., name, locations, and links) without email or phone.
basicWithEmail	false	2	Return basic person fields with email but without phone.
basicWithPhone	false	6	Return basic person fields with phone but without email.
basicWithEmailAndPhone	false	7	Return basic person fields with both email and phone.
premium	false	2	Return premium person fields (e.g., experiences, educations) without email or phone.
premiumWithEmail	false	3	Return premium person fields with email but without phone.
premiumWithPhone	false	7	Return premium person fields with phone but without email.
premiumWithEmailAndPhone	false	8	Return premium person fields with both email and phone.

Basic fields include name, locations, and links, while premium fields include experiences and educations. Please refer to the person object model for a full list of basic versus premium fields.

info

You will only be charged a credit on success. For example, if you request email and no emails are found, your account will not be charged.

Response

The response returns a person object model that matches the provided identifier.

Example Response

{
  "data": {
    "id": "e7c2a3f458ef11edb8780242ac120002",
    "name": "Joe Doe",
    "firstName": "Joe",
    "lastName": "Doe",
    "photoUrl": "https://d1hbpr09pwz0sk.cloudfront.net/logourl/06f524f",
    "birthYear": 1988,
    "emails": [
      {
        "email": "[email protected]",
        "type": "professional",
        "lastValidatedAt": "2020-08-12T02:12:33.231Z",
        "scoreValue": 0.95
      }
    ],
    "phones": [
      {
        "phone": "+1234567890",
        "type": "mobile",
        "lastValidatedAt": "2020-08-12T02:12:33.231Z",
        "scoreValue": 0.90
      }
    ],
    "angellistUrl": "https://angel.co/joedoe",
    "crunchbaseUrl": "https://www.crunchbase.com/person/joedoe",
    "facebookUrl": "https://facebook.com/joedoe",
    "githubUrl": "https://github.com/joedoe",
    "linkedInUrl": "https://linkedin.com/in/joedoe",
    "xUrl": "https://twitter.com/joedoe",
    "youtubeUrl": "https://youtube.com/user/joedoe",
    "unitedStatesStateCode": "CA",
    "unitedStatesCity": "Seattle",
    "unitedStatesZipCode": "98119",
    "unitedStatesRegion": "West Coast",
    "countryCode": "US",
    "worldRegion": "Americas",
    "experiences": [
      {
        "id": "a1b2c3d4e5f611edb8780242ac120003",
        "name": "Acme Inc.",
        "title": "Senior Software Engineer",
        "department": "Engineering",
        "team": "Backend",
        "role": "Individual Contributor",
        "seniority": "Manager",
        "startedAt": "2018-06-15",
        "endedAt": "2022-11-30"
      }
    ],
    "educations": [
      {
        "degree": "Bachelor of Science",
        "institutionDivision": "Engineering",
        "institutionDivisionDepartment": "Computer Science",
        "institutionLevel": "University",
        "institutionName": "University of Washington",
        "startYear": "2006",
        "endYear": "2010"
      }
    ]
  }
}