Identify Person

Endpoint

The Identify Person endpoint is designed to identify individuals from partial or uncertain information. Whether you have outdated emails, names, or phone numbers, this endpoint can match them to a person within the profileAPI database. It provides a confidence score for each match, indicating the reliability of the match.

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

Request

Parameters

To identify a person, specify the email or phone.

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

Hints

• Key: hints
• Data Type: Array<string>
• Description:
• Expression Structure

{
  "all": [ "<filter>" ],
  "any": [ "<filter>" ],
}

Parameter	Type	Description	Example	Required	Default Value
identifiers	array of objects	A set of identifiers used to locate an individual. At least one required.	See Identifier Structure below.	Yes	N/A
queries	array of objects	Detailed snippets of information about the person.	See Query Structure below.	No	N/A
fields	array of strings	Fields to return from the person object model.	[ "name", "department" ]	No	[ "id" ]
minimumConfidenceScore	number	Minimum acceptable confidence score (0-1). Results below this score are not returned.	0.5	No	0

Query Structure

Optional query fields refine the search and improve accuracy:

Field	Type	Description	Example
personLinkedInQuery	string	LinkedIn profile URL or handle.	"https://linkedin.com/in/johndoe"
personCrunchbaseQuery	string	Crunchbase profile URL or handle.	"https://crunchbase.com/person/john-doe"
personTwitterQuery	string	Twitter profile URL or handle.	"@johndoe"
personLocationQuery	string	Free-text description of location, e.g., city, state, country.	"Fremont, California"
companyNameQuery	string	Name of the company where the person works or worked.	"Google"
companyIndustryQuery	string	Industry of the company where the person works or worked.	"Technology"

---

Example Request

JSON Request

{
  "identifiers": [
    {
      "personNameQuery": "John Doe"
    }
  ],
  "queries": [
    {
      "personTitleQuery": "Software Engineer"
    },
    {
      "personEducationInstitutionNameQuery": "Arizona State University"
    }
  ],
  "minimumConfidenceScore": 0.5
}

Response Structure

JSON Response

{
  "data": {
    "id": "9e6a55b258ef11edb8780242ac120002",
    "linkedInUrl": "https://linkedin.com/in/johndoe",
    "confidence": 0.95
  }
}