Social Presence

The Social Presence API allows you to pass an e-mail and/or a phone number of a client and retrieve information about platforms these credentials are registered in.

Retrieving social presence data

In order to retrieve social presence data, execute an HTTP GET request to the URL below. It is mandatory to have at least email or phone parameter present.

URL: https://data.jeff-app.com/partner-api/1.0/social-data

Query parameters:

> In case of a successful submission an HTTP 200 response is returned with a JSON body in the following form:

{
  "platformPresenceFacts": [
    {
      "id": 28291484,
      "created": "2023-10-11T14:15:48.531457",
      "platform": "apple",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291470,
      "created": "2023-10-11T14:15:45.689966",
      "platform": "booking",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291472,
      "created": "2023-10-11T14:15:45.799657",
      "platform": "booking",
      "present": false,
      "credentialType": "PHONE"
    },
    {
      "id": 28291497,
      "created": "2023-10-11T14:15:50.573201",
      "platform": "facebook",
      "present": false,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291514,
      "created": "2023-10-11T14:16:08.107327",
      "platform": "facebook",
      "present": true,
      "credentialType": "PHONE"
    },
    {
      "id": 28291469,
      "created": "2023-10-11T14:15:45.564377",
      "platform": "github",
      "present": false,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291472,
      "created": "2023-10-11T14:16:42.564311",
      "platform": "netflix",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291508,
      "created": "2023-10-11T14:15:53.621066",
      "platform": "google",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291512,
      "created": "2023-10-11T14:15:59.247238",
      "platform": "google",
      "present": true,
      "credentialType": "PHONE"
    },
    {
      "id": 28291484,
      "created": "2023-10-11T14:15:47.893164",
      "platform": "instagram",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291485,
      "created": "2023-10-11T14:15:48.883164",
      "platform": "instagram",
      "present": true,
      "credentialType": "PHONE"
    },
    {
      "id": 28291478,
      "created": "2023-10-11T14:15:47.614644",
      "platform": "lazada",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291486,
      "created": "2023-10-11T14:15:49.078331",
      "platform": "lazada",
      "present": true,
      "credentialType": "PHONE"
    },
    {
      "id": 28291499,
      "created": "2023-10-11T14:15:50.411477",
      "platform": "linkedin",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291477,
      "created": "2023-10-11T14:15:47.602809",
      "platform": "microsoft",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291471,
      "created": "2023-10-11T14:15:45.707403",
      "platform": "microsoft",
      "present": false,
      "credentialType": "PHONE"
    },
    {
      "id": 28291487,
      "created": "2023-10-11T14:15:49.129091",
      "platform": "pinterest",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291494,
      "created": "2023-10-11T14:15:50.202594",
      "platform": "skype",
      "present": true,
      "credentialType": "EMAIL",
      "details": {
        "id": "live:1de8f11d356bf276",
        "name": "Jeff Daniels",
        "photo": "https://avatar.skype.com/v1/avatars/live:1de8f11d356bf277/public?returnDefaultImage=true&size=m",
        "city": "Hồ Chí Minh",
        "country": "Vietnam",
        "isBusinessAccount": false
      }
    },
    {
      "id": 28291480,
      "created": "2023-10-11T14:15:47.894092",
      "platform": "skype",
      "present": true,
      "credentialType": "PHONE",
      "details": {
        "id": "live:1de8f11d356bf276",
        "name": "Jeff Daniels",
        "photo": "https://avatar.skype.com/v1/avatars/live:1de8f11d356bf277/public?returnDefaultImage=true&size=m",
        "city": "Hồ Chí Minh",
        "country": "Vietnam",
        "isBusinessAccount": false
      }
    },
    {
      "id": 28291473,
      "created": "2023-10-11T14:15:46.530926",
      "platform": "spotify",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291474,
      "created": "2023-10-11T14:15:46.959822",
      "platform": "twitter",
      "present": true,
      "credentialType": "EMAIL"
    },
    {
      "id": 28291476,
      "created": "2023-10-11T14:15:47.522598",
      "platform": "twitter",
      "present": true,
      "credentialType": "PHONE"
    },
    {
      "id": 28291489,
      "created": "2023-10-11T14:15:49.778366",
      "platform": "zalo",
      "present": true,
      "credentialType": "PHONE"
    }
  ],
  "errorMessage": null
}

> In case there is a problem with the query parameters passed, an HTTP 400 response is returned with a JSON body in the following form:

{
  "errorMessage": "Wrong phone number format. Please check the documentation"
}

Response waiting times

Longer waiting times (controlled by the max-wait-time-seconds parameter) increase the hit rate of the social presence data for the given email/phone. Some of the platforms reach 95% hit rate in 5 seconds, some take up to 30. If all the desired data points are gathered before timeout is reached, response returns immediately.

Field descriptions

Platform presence facts

Information of in which external platforms email and/or phone number are registered

Supported platforms