[Deprecated] Person Manual
With the v5 schema, our goal is to make persistence commitments regarding how each field will evolve between data releases. We aim to do this in order to help our customers build applications around our data that are sustainable.
Any changes outside the potential changes listed here will be announced 90 days in advance of any release.
Standard Fields
Field Name | Persistence Commitments and Format |
---|---|
birth_date | Date string in YYYY-mm-dd format. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY). If this exists, birth_year will agree with this |
birth_year | Date string. Only year (YYYY) |
countries | List of valid PDL countries -- Canonical Countries |
education.degrees | List of Canonical Degrees that can be changed between releases |
education.end_date | Date string in YYYY-mm-dd format. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY) |
education.gpa | 0.0 <= x <= 5.0 |
education.majors | Canonical Majors that can be changed between releases |
education.minors | Canonical Majors that can be changed between releases |
education.school.domain | a valid domain with tld |
education.school.facebook_url | The website associated with the school |
education.school.id | ids could change from build to build but are likely to stay relatively the same in the short-mid term. Relational dataset will be 1to1 with ID's available in current person version |
education.school.linkedin_id | part of relational dataset |
education.school.linkedin_url | part of relational dataset |
education.school.location.continent | relational data - should align with location relational data |
education.school.location.country | relational data - should align with location relational data |
education.school.location.locality | relational data - should align with location relational data |
education.school.location.name | locality, region, country format. relational data - should align with location relational data |
education.school.location.region | relational data - should align with location relational data |
education.school.location | canonical locations which can be retrieved via the cleaner apis |
education.school.name | part of relational dataset |
education.school.twitter_url | part of relational dataset |
education.school.type | primary school, secondary school, post-secondary institution |
education.school.website | a valid domain with tld |
education.school | canonical schools which can be retrieved via the cleaner apis |
education.start_date | Date string in YYYY-mm-dd format. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY) |
education | |
emails.address | a valid email format |
emails.type | email types |
emails | |
experience.company.facebook_url | part of relational dataset |
experience.company.founded | part of relational dataset |
experience.company.id | ids could change from build to build but are likely to stay relatively the same in the short-mid term. Relational dataset will be 1to1 with ID's available in current person version |
experience.company.industry | part of relational dataset |
experience.company.linkedin_id | part of relational dataset |
experience.company.linkedin_url | part of relational dataset |
experience.company.location.address_line_2 | part of relational dataset |
experience.company.location.continent | relational data - should align with location relational data |
experience.company.location.country | relational data - should align with location relational data |
experience.company.location.geo | relational data - should align with location relational data |
experience.company.location.locality | relational data - should align with location relational data |
experience.company.location.metro | relational data - should align with location relational data |
experience.company.location.name | relational data - should align with location relational data |
experience.company.location.postal_code | relational data - should align with location relational data |
experience.company.location.region | relational data - should align with location relational data |
experience.company.location.street_address | part of relational dataset |
experience.company.location | canonical locations which can be retrieved via the cleaner apis |
experience.company.name | part of relational dataset |
experience.company.size | part of relational dataset: Canonical company size ranges |
experience.company.twitter_url | part of relational dataset |
experience.company.website | part of relational dataset |
experience.company | canonical companies which can be retrieved via the cleaner apis |
experience.end_date | Date string in YYYY-mm-dd format. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY) |
experience.is_primary | true, false |
experience.location_names | locality, region, country |
experience.start_date | Date string in YYYY-mm-dd format. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY) |
experience.title.levels | list of persistent enum strings that will only be added to. logical output of title levels from title.name can change Canonical Levels |
experience.title.name | Free Text Field |
experience.title.role | Canonical Data for Roles persistent enum -- never remove only append. Individual records may gain // lose values |
experience.title.sub_role | Canonical Data for Subroles persistent enum -- never remove only append. Individual records may gain // lose values. Title Subroles each map to a Role |
experience.title | free text |
experience | list of objects "experience" objects |
facebook_id | digital strings |
facebook_url | facebook.com/username -- not necessarily an active profile |
facebook_username | free text field with blacklisted values |
first_name | free text field with blacklisted values. Always exists |
full_name | generated from first_name and last_name field. Always exists |
sex | male, female |
github_url | github.com/username -- not necessarily an active profile |
github_username | free text field with blacklisted values |
id | persistent ids |
industry | Canonical Industries |
interests | free text field |
job_company_facebook_url | part of relational dataset |
job_company_founded | part of relational dataset |
job_company_id | part of relational dataset |
job_company_industry | part of relational dataset |
job_company_linkedin_id | part of relational dataset |
job_company_linkedin_url | part of relational dataset |
job_company_location_address_line_2 | relational data - should align with location relational data |
job_company_location_continent | relational data - should align with location relational data |
job_company_location_country | relational data - should align with location relational data |
job_company_location_geo | relational data - should align with location relational data |
job_company_location_locality | relational data - should align with location relational data |
job_company_location_name | relational data - should align with location relational data |
job_company_location_postal_code | relational data - should align with location relational data |
job_company_location_region | relational data - should align with location relational data |
job_company_location_street_address | relational data - should align with location relational data |
job_company_name | part of relational dataset |
job_company_size | part of relational dataset: Canonical company size ranges |
job_company_twitter_url | part of relational dataset |
job_company_website | part of relational dataset |
job_last_updated | Date string. (YYYY-MM-DD). |
job_start_date | Date string in YYYY-mm-dd format. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY) |
job_title_levels | list of persistent enum strings that will only be added to. logical output of title levels from title.name can change Canonical Levels |
job_title_role | Canonical Data for Roles persistent enum -- never remove only append. Individual records may gain // lose values |
job_title_sub_role | Canonical Data for Subroles persistent enum -- never remove only append. Individual records may gain // lose values. Title Subroles each map to a Role |
job_title | primary experience.title.name |
last_name | free text field with blacklisted values. Always exists |
linkedin_id | digital strings |
linkedin_url | linkedin.com/in/username -- not necessarily an active profile |
linkedin_username | free text field with blacklisted values |
location_address_line_2 | free text following set formats |
location_continent | part of relational dataset List of continents |
location_country | part of relational dataset List of countries |
location_geo | part of relational dataset. Lat Lon city center rounded to two digits |
location_last_updated | Date string (YYYY-MM-DD) |
location_locality | part of relational dataset |
location_metro | List of metros |
location_name | part of relational dataset |
location_names | from relational dataset |
location_postal_code | a US (5 digit) or canadian (7 digit with space as middle char) postal code. Other countries may be added at a future date |
location_region | part of relational dataset |
location_street_address | free text following set formats |
middle_initial | single char |
middle_name | free text field with blacklisted values |
mobile_phone | E164 |
operation_id | Sha-256 Hash |
personal_emails | List of strings. Will always follow [email protected] |
phone_numbers | E164 |
profiles.id | digital strings |
profiles.network | Valid profile networks. Networks may be added but never removed |
profiles.url | Always follows a set url format, no protocol/www |
profiles.username | free text field with blacklisted values |
profiles | |
regions | region, country |
skills | free text field |
street_addresses.address_line_2 | free text following set formats |
street_addresses.continent | part of relational dataset |
street_addresses.country | part of relational dataset |
street_addresses.geo | part of relational dataset. Lat Lon city center rounded to two digits |
street_addresses.locality | part of relational dataset |
street_addresses.metro | List of metros |
street_addresses.name | part of relational dataset |
street_addresses.postal_code | a US (5 digit) or canadian (7 digit with space as middle char) postal code. Other countries may be added at a future date |
street_addresses.region | part of relational dataset |
street_addresses.street_address | free text following set formats |
street_addresses | List of full parsed addresses associated with the person |
twitter_url | twitter.com/username -- not necessarily an active profile |
twitter_username | free text field with blacklisted values |
version_status.contains | list of valid PDL Ids |
version_status.current_version | PDL data versions follow a major.minor format |
version_status.previous_version | PDL data versions follow a major.minor format |
version_status.status | One of six values outlined Here |
version_status | Allows customers track the pervious and current dataset version, any other persistent IDs that were merged into this record using improved entity resolution, and the status of the record |
work_email | Will always follow [email protected] |
Restricted Fields
Field Name | Persistence Commitments and Format |
---|---|
certifications | |
certifications.end_date | Date string. YYYY-MM-DD |
certifications.name | Free Text Field |
certifications.organization | Free Text Field |
certifications.start_date | Date string. YYYY-MM-DD |
education.raw | Free Text Field |
education.school.raw | Free Text Field |
education.summary | Free Text Field, Cased |
experience.company.raw | Free Text Field |
experience.company.ticker | Free Text Field, capitalized |
experience.company.type | Types |
experience.summary | Free Text Field, Cased |
experience.title.raw | Free Text Field |
inferred_salary | Ranges |
inferred_years_experience | Between 0 and 100 |
job_company_ticker | Free Text Field, capitalized |
job_company_type | Types |
job_summary | Free Text Field, Cased |
languages | |
languages.name | Canonical Languages |
languages.proficiency | Score 1-5 |
linkedin_connections | Typically 0-500, some are the true values over 500 |
summary | Free Text Field, Cased |
Updated 9 months ago