Skip to main content

PeopleSearchState

The search state the server keeps on the report — what a client needs to restore the chat.

fields objectrequired

What the user knows about the person. Every key is optional; a search needs one of name / username / phone. state / country are the place LEVELS a refinement question resolved — separate slots, never glued onto location.

Input policy (also CreateRequest.name / username / state and the typed text of run and parse). maxLength counts Unicode code points. The server first normalizes every value: NFC; invisible characters removed (zero-width, bidi controls, BOM, soft hyphen, tag characters; ZWJ / ZWNJ kept); a line break becomes a space (; in info / work / interests / life, one newline in text), any other control character a space; { } [ ] < > ` \ $ ^ * " and their full-width forms become a space; whitespace collapsed and trimmed, empty = unset. Then name needs a letter; username is at most 3 distinct handles [a-z0-9._-]{1,50} (a link is read down to its handle, @ dropped, lowercased), sent on as "h1, h2"; phone is one number (digits, spaces, + ( ) - . /, dashes; a + only in front or right after a leading ( — (+34) 612…; at most 15 digits; full-width digits, +, brackets and dashes and the … of smart punctuation are folded to their ASCII forms first, and the cap counts the folded number); gender other than male / female is dropped; language is a code (pt-BR) or a name. No patterns or enums here on purpose: normalization runs first, so a pasted invisible character is removed, not a 400. maxLength itself is checked on the value as sent, before normalization: a value over its cap only because of invisible characters is still a 400, and phone's 40 applies both to the value as sent and to the folded number.

Errors: 400 with GeneralError.message = <code>:<field> (the field's name or JSON pointer, e.g. input_too_long:/fields/name). Stable codes: input_too_long, input_empty (a blank text), input_no_letters, username_too_many_handles, username_bad_handle, phone_bad_format, language_bad; input_invalid for any other schema violation. A pointer names only properties declared here and array indexes — any other key (a map key) is *. A body key that differs from a declared property only in case (Username) is input_invalid:<pointer to that property>; a body that passes the schema but does not decode (a number beyond its integer type) is input_invalid:/. A body over 128 KiB is 413 body_too_large. The rejected value is never echoed back or logged.

namestring

Possible values: <= 100 characters

usernamestring

@handle, with or without the @; up to 3 handles or profile links, comma or space separated

Possible values: <= 200 characters

phonestring

A full number ALWAYS makes the report a phone lookup, wherever it arrives (at create or in a later round): the number ALONE is searched — a name and facts sent with it are kept on the report, not searched — and the results are masked from that round on. There is no combined "name + phone" search. The last two digits alone are not a phone number: such a value is dropped and never masks anything.

Possible values: <= 40 characters

locationstring

Possible values: <= 100 characters

statestring

Possible values: <= 64 characters

countrystring

Possible values: <= 64 characters

infostring

Anything else, free text — the pieces of several turns, ; -separated.

Possible values: <= 500 characters

genderstring

male or female (any case); anything else is dropped.

Possible values: <= 16 characters

languagestring

Possible values: <= 16 characters

workstring

Possible values: <= 200 characters

interestsstring

Possible values: <= 200 characters

lifestring

Possible values: <= 200 characters

brandstring

Possible values: <= 100 characters

askedstring[]required
exclude_idsobjectrequireddeprecated

Always {} — the platform no longer keeps exclusions (PeopleSearchRequest.exclude_ids is ignored).

picked object[]required
  • Array [
  • sourceSource (string)required

    source social network of profile

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

    Default value: tw
    idProfileId (string)required

    id of profile

  • ]
  • interest_idsinteger<int64>[]required
    textstring
    fixes object[]
  • Array [
  • startintegerrequired

    Possible values: >= 0 and <= 200

    endintegerrequired

    Possible values: >= 0 and <= 200

    tagstringrequired

    Possible values: <= 16 characters

  • ]
  • roundsintegerrequired
    rounds_leftintegerrequired
    orderSource (string)[]

    The last round's PeopleSearchResponse.order (li never first).

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

    tiers object
    property name*integer
    last_search_atstring<date-time>
    seed_origin object

    The account the current query was seeded from, when it was.

    sourceSource (string)required

    source social network of profile

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

    Default value: tw
    idProfileId (string)required

    id of profile

    phone_mask object

    Set on a phone lookup whose exact lookup bound the number to nobody while the Instagram password-recovery mask (country code, length, the last two digits) fits count accounts. A round with a NAME on such a report searches by it among them, masked, the typed name readable (PeopleSearchPanel.blurred); a round without a name is the lookup of the number again. Absent on every other report.

    Its answer is a PERSON: only Instagram's accounts carry the mask, so only Instagram is searched and its panel is cut to one, a few (≤ 3) or nobody (PeopleSearchPanel.lead); the round's other networks — send every network, in ONE part — answer the identity graph's certain partners of those Instagram accounts, each saying whose it is (PeopleSearchCard.linked_to). No refinement question is asked. count is the size of the pool, about half a million for any US number — not a figure to show.

    countinteger<int64>required

    The Instagram accounts whose recovery mask fits the number.

    Possible values: >= 1

    searchedboolean

    The stored panels are a search by name among them (the last round had a name).

    Default value: false
    linkedin_origin object

    The LinkedIn profile this search started from (POST /people-search/linkedin/{reportId} answered status: index). It is the report's, not a pick: the client never sends it, a round does not change it and un-picking a card does not drop it — every round of the report (run or seed; not a phone lookup's) pins on top of the panels the accounts the identity graph ties to it, as any pin — the card never says which pick pinned it. The next LinkedIn read of the report replaces it, or removes it when that read is not index. Absent otherwise.

    slugstringrequired
    fullnamestringrequired

    The name as our database holds it (may be empty — the search then runs by fullname of the answer).

    linkstringrequired

    https://www.linkedin.com/in/<slug>.

    PeopleSearchState
    {
    "fields": {
    "name": "string",
    "username": "string",
    "phone": "string",
    "location": "string",
    "state": "string",
    "country": "string",
    "info": "string",
    "gender": "string",
    "language": "string",
    "work": "string",
    "interests": "string",
    "life": "string",
    "brand": "string"
    },
    "asked": [
    "string"
    ],
    "picked": [
    {
    "source": "tw",
    "id": "string"
    }
    ],
    "interest_ids": [
    0
    ],
    "text": "string",
    "fixes": [
    {
    "start": 0,
    "end": 0,
    "tag": "string"
    }
    ],
    "rounds": 0,
    "rounds_left": 0,
    "order": [
    "tw"
    ],
    "tiers": {},
    "last_search_at": "2024-07-29T15:51:28.071Z",
    "seed_origin": {
    "source": "tw",
    "id": "string"
    },
    "phone_mask": {
    "count": 0,
    "searched": false
    },
    "linkedin_origin": {
    "slug": "string",
    "fullname": "string",
    "link": "string"
    }
    }