Skip to main content
Find the most accurate Facebook profile match using intelligent multi-factor search.

​
Method

client.profiles.search(params: ProfileSearchParams): Promise<ProfileSearchResponse>

​
Parameters

​
name
string
required
The name of the person to search for. Minimum 1 character.
​
email
string
Email address associated with the profile (optional).
​
birthYear
number
Birth year (e.g., 1990). Must be between 1900 and current year.
​
dateOfBirth
string
Full date of birth in ISO format (YYYY-MM-DD), e.g., “1990-05-15”.
​
location
string
Location to search (city, state, country, etc.). Minimum 2 characters.
​
subCategory
string
Location category: "hometown" or "current". Used when location is provided.
​
photoUrl
string
URL of a photo to compare against profile photos for facial recognition matching. Provide either photoUrl or photoBase64, but not both.
​
photoBase64
string
Base64-encoded image data URI (e.g., data:image/jpeg;base64,...). Provide either photoUrl or photoBase64, but not both.
​
knownAssociates
string[]
Array of Facebook profile URLs or IDs of known associates (mutual friends, connections). Maximum 20 items.
​
additionalInstructions
string
Additional instructions to append to the AI prompt for custom search criteria.

​
Usage

const result = await client.profiles.search({
  name: 'John Doe',
  location: 'New York, NY',
  birthYear: 1990
});

console.log('Primary match:', result);

​
Response

Returns a ProfileSearchResponse object.