Skip to main content
Check if a list of candidate profiles are friends with a target Facebook profile.

​
Method

client.checkFacebookFriends.create(params: CheckFacebookFriendsCreateParams): Promise<CheckFacebookFriendCreateResponse>

​
Parameters

​
targetFacebookId
string
required
The Facebook profile ID of the target user to check friendships against.
​
candidateIds
string[]
required
Array of Facebook profile IDs to check. Must contain at least one ID.

​
Usage

const result = await client.checkFacebookFriends.create({
  targetFacebookId: '123456789',
  candidateIds: [
    '987654321',
    '111222333',
    '444555666'
  ]
});

console.log('Confirmed friends:', result);

​
Response

Returns a CheckFacebookFriendCreateResponse object containing the confirmed connections.