Enrich API data field descriptions

            Person Summary Object

            * Queryable Inputs - These data items are used for querying and only returned in response if provided in the request

            Data Element Name

            Description

            email *

            The email address of the contact. 

            emailHash *

            Either an MD5 or SHA-256 hash representation of the email address to query. Be certain to lowercase and trim the email address prior to hashing.

            phone *

            Phone number of the contact.

            twitter *

            Twitter handle of the contact. Acceptable formats include handle (with or without "@"), as well as the URL to the profile.

            fullName

            Full name of the contact.

            ageRange

            Age range of the contact.

            gender

            Gender of the contact.

            location

            Location of the contact. Depending on data quality, the exactness of this value may vary.

            title

            Current or most recent job title.

            organization

            Current or most recent place of work.

            linkedin

            URL of the contact's LinkedIn profile.

            facebook

            URL of the contact's Facebook profile.

            bio

            Biography of the contact.

            avatar

            URL of the contact's photo.

            website

            URL of the contact's website.

            details

            When included, additional details about the contact provided through Data Add-ons will be available here.


            Person Data Add-ons

            Affinity Add-on

            Data Element Name

            Description

            name

            The name of the topic of interest.

            id

            The ID of the topic of interest. This can be used to identify parent->child relationships in topics.

            affinity

            The level of affinity between the contact and this topic. Values are HIGH, MED, or LOW.

            parentIds

            An array of strings representing any parent topics associated with this topic. These will match with the id property of other topics returned in the Data Add-on.

            category

            The category of this topic of interest.

             

            All Social Data Add-on

            Data Element Name

            Description

            profile.{platform}.username

            Displayable username of the profile.

            profile.{platform}.userid

            User ID associated with the profile.

            profile.{platform}.url

            URL to the profile on the social platform.

            profile.{platform}.bio

            Bio of the profile form the social platform.

            profile.{platform}.service

            Name of the social platform.

            profile.{platform}.followers

            Number of followers of the profile, if applicable.

            profile.{platform}.following

            Number of profiles or topics the user is following, if applicable.

            photos[n].label

            The type of photo.

            photos[n].value

            The URL to the photo.

            urls[n].label

            The type of URL/website.

            urls[n].value

            The URL of the website.

             

            Demographics Add-on (Included in monthly plan)

            Data Element Name

            Description

            name.given

            The given name (first name) of the individual.

            name.family

            The family name (last name) of the individual.

            name.middle

            The middle name of the individual.

            name.prefix

            The prefix, if any, used for the individual. Examples: Mr, Mrs, Dr.

            name.suffix

            The suffix, if any, used for the individual. Examples: Jr.

            name.nickname

            The nickname, if any, used for the individual.

            age.birthday.year

            The birth year of the individual.

            age.birthday.month

            The birth month of the individual.

            age.birthday.day

            The birth day of the individual.

            age.range

            An age range of the individual. Possible ranges are: 18-24, 25-34, 35-44, 45-54, 55-64 or 65+

            age.value

            The age in years of the individual.

            gender

            The gender of the individual.

            locations[n].label

            An indicator for how the location was obtained.

            locations[n].city

            The "city" portion of the location address.

            locations[n].region

            The region portion of the location address, typically a state or province.

            locations[n].regionCode

            An abbreviated or code-based representation of the region.

            locations[n].country

            The country portion of the location address.

            locations[n].countryCode

            The abbreviated or code-based representation of the country.

            locations[n].formatted

            The formatted address.

            education[n].name

            The name of the school/university attended.

            education[n].degree

            The degree or focus of study.

            education[n].start.year

            The first year of attendance.

            education[n].end.year

            The last year of attendance.

             

            Email Hash Add-on

            Data Element Name

            Description

            label

            An indicator of the source or type of email. If provided in the Person request, the value will be provided, otherwise, hash.

            value

            Used only when email address has been provided and is being returned.

            md5

            The MD5 hash representation for a given email address.

            sha256

            The SHA-256 hash representation for a given email address.

             

            Employment History Add-on

            Data Element Name

            Description

            name

            The name of the organization/place of employment.

            domain

            The domain of the organization/place of employment.

            current

            Indicator of whether or not this is the current place of employment.

            title

            Job or position title.

            start

            Object representing start date, with properties for year, month and day returned as integers.

            end

            Object representing end date, with properties for year, month and day returned as integers.

             

            Topics Add-on (Included in monthly plan)

            Data Element Name

            Description

            topics[n]

            The name of the topic.

             

            Key People Add-on

            Data Element Name

            Description

            keyPeople[n].fullName string

            The full name of the person

            key.People[n].title string

            The job title of the person

            keyPeople[n].avatar string

            A URL to a photo or avatar of the person

             

            Company Enrichment

            Data Element Name

            Description

            name string

            The name of the company

            location string

            The location or address of the company

            twitter string

            The URL to the Twitter profile associated with the company

            linkedin string

            The URL to the Linkedin profile associated with the company

             facebook string

            The URL to the Facebook profile associated with the company

            bio string

            The company's bio

            logo string

            URL to the logo or image for the company

            web site string

            URL to the company's website

            founded string

            The year the company was founded

            employees string

            An approximate number of employees with the company

            locale string

            The locale of the company

            category string

            The category of the company. Possible values are Adult, Email Provider, Education, SMS, or Other

            details.entity.name string

            The name of the company

            details.entity.founded string

            The year in which the company was founded

            details.entity.employees integer

            The approximate number of employees

            locales[n].code string

            The code for each locale of the company

            locales[n].name string

            The displayable name for each locale of the company

            categories[n].code string

            The code for each category of the company.Possible values are Adult, Email Provider, Education, SMS, or Other

            categories[n].name string

            The displayable name for each category of the company

            industries[n].type string

            The type of industry classification/code being used. Possible values are NAICS, SIC; This will return the short code used to identify the industry in national census. Those lists are available online, and are not managed by FullContact.

            industries[n].name string

            The name for each of the industry classifications of the company

            emails[n].value string

            An email address associated with the company

            emails[n].label string

            The type of label of the email address, with values such as sales, work, and other

            phones[n].value string

            A phone number associated with the company

            phones[n].label string

            The type or label of the phone number, with values such as sales, work, and other

            profiles.{platform}.username string

            Displayable username of the profile

             

             

             

             

            Updated: 12 Apr 2019 04:06 AM
            Helpful?  
            Help us to make this article better
            22 9