candidate object contains the full profile data returned by the Person API for a successfully matched individual. It appears in two contexts:
- In the callback payload (async mode) — inside each array item where
statusissuccess - In the response body (sync mode,
withoutWaterfall: true) — same structure, returned directly without a callback
null or an empty array [].
Below is a full description of all fields.
Full Example
Top-Level Fields
List of location objects. Each object contains a single
name string field (e.g. "New York, New York, United States").contacts
Array of contact items. WhenwithoutContacts: true is used, this field is always returned as an empty array []. Each item has the following fields:
Contact type. Possible values:
email, phone, link, skype, telegram, whatsapp, viber, hangouts, wechat, qq, icq, gtalk, aim, windows_live_messenger, yahoo_messenger.Confidence score indicating contact validity. Possible values:
70 (likely valid) or 100 (high confidence).For emails:
work, personal, or null. For phones: work_phone, mobile, or null. For other types: null.social
Array of social profile links. WhenwithoutContacts: true is used, only the LinkedIn profile link is returned (if available). Each item has the following fields:
Confidence score indicating link validity. Possible values:
70 (likely valid) or 100 (high confidence).experience
Array of work experience entries. Each item contains:education
Array of education entries. Each item contains:Other Fields
The following fields follow the same pattern — each is an array of objects that may be empty ([]). All fields within each object are string | null.
Additional Fields
For a small subset of profiles, additional data may be present. These fields should not be relied upon as they are available only occasionally. They are omitted entirely when not available — never returned asnull or [].