Skip to main content

Match

idstringrequired

Unique match ID

partialNamestringrequired

Partially visible name and username (e.g., "O*** Black"). Both name and username are blurred, showing only first letter followed by blur symbols

isBlurredbooleanrequired

Whether the name is blurred. Note: consensusName is only available after matches are selected (see SearchResultsResponse)

sourceSource (string)required

Social network source identifier

Possible values: [fb, ig, tt, tw]

Example: fb
thumbnailstring<uri>required

Thumbnail image URL

usernamestring

Username on the social network

selectedboolean

Whether this match is selected

scorenumber<float>nullable

Match confidence score 0–1 (included only for admin role)

qualitystringnullable

Derived match-confidence tier. best when score > 0.7, likely when 0.55 <= score <= 0.7, absent/null below 0.55. Computed server-side; available to ALL roles (unlike score, admin-only).

Possible values: [best, likely]

excludedByLawboolean

When true, account is excluded from search results by law (e.g. GDPR). Only present when true.

Match
{
  "id": "match_001",
  "partialName": "O*** Black",
  "isBlurred": true,
  "source": "fb",
  "thumbnail": "https://cdn.face2social.com/thumbs/match_001.jpg",
  "username": "o.black",
  "selected": false
}