Enrich Persons

Endpoint

This endpoint returns an array of person object model. The person is identified id or linkedInUrl.

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

Request

Parameters

To enrich a person, specify either id, or linkedInUrl.

Ids (Option A)

• Key: ids
• Data Type: Array of <string>
• Description: An array of universally unique identifier (UUID) compliant with RFC 4122 specification, used to uniquely identify entities in the system. Presented without hyphens.
• Example: ["9e6a55b258ef11edb8780242ac120002"]

LinkedIn URLs (Option B)

• Key: linkedInUrls
• Data Type: Array of <string>
• Description: URL to a LinkedIn profile.
• Format: https://linkedin.com/in/[handle]
• Example: [ "https://linkedin.com/in/joedoe" ]

important

You can only pass either option A or B, but not both. There is a maxium of 100 ids or linkedInUrls

Fields To Return

• Key: fieldsToReturn
• Data Type: string
• Description: The fields to return
• Options:

Name	Default	Credits Per Person	Description
basic	true	1	Return basic person fields to include name, locations, links and current employment.
premium	false	2	Return premium person fields such as job and education history.

Please refer to person object model for a list of basic vs premium fields.

Example

{ 
  "ids": [ "9e6a55b258ef11edb8780242ac120002" ],
  "fieldsToReturn": "premium"
}

{ 
  "linkedInUrls": [ "https://linkedin.com/in/joedoe" ],
  "fieldsToReturn": "premium"
}

info

You will only be charged a credit on success. If we don't find the person, you will not be charged.

Response

The response includes an array of person object model.

Example Response

{
    "data": {
        "results": [
            {
                "id": "e7c2a3f458ef11edb8780242ac120002",
                "name": "Joe Doe",
                "firstName": "Joe",
                "lastName": "Doe",
                "photoUrl": "https://d1hbpr09pwz0sk.cloudfront.net/logourl/06f524f",
                "birthYear": 1988,
                "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"
                    }
                ]
            }
        ],
        "pagination": {
            "nextStart": [
                {
                    "id": "9e6a55b258ef11edb8780242ac121233",
                    "score": 0.92
                }
            ]
        }
    }
}