Response Body
Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:
Success– Successful transaction
MissingParameter- A required parameter wasn't provided
InvalidParameter- A parameter was incorrectly specified
AuthenticationError- An error occurred with the credentials provided
Unauthorized- Your account doesn't have permission to perform this operation
DataNotFound- Data with the specified name wasn't found
The following is a list of codes that can be returned by the service:
Success– Successful transaction
MissingParameter- A required parameter wasn't provided
InvalidParameter- A parameter was incorrectly specified
AuthenticationError- An error occurred with the credentials provided
Unauthorized- Your account doesn't have permission to perform this operation
DataNotFound- Data with the specified name wasn't found
Info.Messagestring
This message further describes the code providing additional detail.
Info.TransactionIdstring
The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.
Info.EngineVersionstring
The version of the parsing/matching engine running under-the-hood.
Info.ApiVersionstring
The version of the API.
Info.TotalElapsedMillisecondsinteger
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
Info.TransactionCostdecimal
How many credits the transaction costs.How many credits the transaction costs.
Info.CustomerDetailsobject
Information about the customer who made the API call.
Value.CustomerDetails.AccountIdstring
The AccountId for the account.
Value.CustomerDetails.Namestring
The customer name on the account.
Value.CustomerDetails.IPAddressstring
The client IP Address where the API call originated.
Value.CustomerDetails.Regionstring
The region for the account, also known as the 'Data Center'.
Value.CustomerDetails.CreditsRemainingdecimal
The number of credits remaining to be used by the account.
Value.CustomerDetails.CreditsUseddecimal
The number of credits used by the account.
Value.CustomerDetails.MaximumConcurrentRequestsinteger
The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
Valueobject
All of the information extracted while parsing a resume.
Value.ContactInformationobject
The candidate's contact information found on the resume.
Value.ContactInformation.CandidateNameobject
The candidate's name.
Value.ContactInformation.CandidateName.FormattedNamestring
The name in a standard format.
Value.ContactInformation.CandidateName.Prefixstring
A prefix for a name, such as Dr.
Value.ContactInformation.CandidateName.GivenNamestring
The given (first) name.
Value.ContactInformation.CandidateName.MiddleNamestring
The middle name or initial.
Value.ContactInformation.CandidateName.FamilyNamestring
The family (last) name.
Value.ContactInformation.CandidateName.Suffixstring
A suffix for a name, such as Jr. or III.
Value.ContactInformation.Telephonesobject[]
The candidate's phone numbers.
Value.ContactInformation.Telephones[i].Rawstring
The raw value found in the text.
Value.ContactInformation.Telephones[i].Normalizedstring
The normalized value.
Value.ContactInformation.Telephones[i].InternationalCountryCodestring
The international country code part of the phone number.
Value.ContactInformation.Telephones[i].AreaCityCodestring
The area code part of the phone number.
Value.ContactInformation.Telephones[i].SubscriberNumberstring
The subscriber number part of the phone number.
Value.ContactInformation.EmailAddressesstring[]
The candidate's email addresses.
Value.ContactInformation.Locationobject
The candidate's location/address
Value.ContactInformation.Location.CountryCodestring
The 2-letter ISO 3166 country code.
Value.ContactInformation.Location.PostalCodestring
The Postal or Zip code.
Value.ContactInformation.Location.Regionsstring[]
The Regions/Districts/States.
Value.ContactInformation.Location.Municipalitystring
The City/Municipality/Town.
Value.ContactInformation.Location.StreetAddressLinesstring
Street address lines.
Value.ContactInformation.Location.GeoCoordinatesobject
If geocoding has been done, this is the lat/lon for the location.
Value.ContactInformation.Location.GeoCoordinates.Latitudedecimal
The latitude, in degrees.
Value.ContactInformation.Location.GeoCoordinates.Longitudedecimal
The longitude, in degrees.
Value.ContactInformation.Location.GeoCoordinates.Sourcestring
The geocoding source, such as Google or Bing.
Value.ContactInformation.WebAddressesobject[]
The candidate's web addresses (URLs, social media) listed on the resume.
Value.ContactInformation.WebAddresses[i].Addressstring
The URL or username
Value.ContactInformation.WebAddresses[i].Typestring
The type of address. One of:
- PersonalWebsite
- GitHub
- Skype
- StackOverflow
- Signal
- Quora
- ICQ
- Telegraph
- Telegram
- MeWe
- Parler
- Gab
- Unknown
Value.ProfessionalSummarystring
The professional summary from the resume.
Value.Objectivestring
The candidate's written objective.
Value.PersonalAttributesobject
Personal information provided by the candidate on the resume.
Value.PersonalAttributes.Availabilitystring
The availability of the candidate.
Value.PersonalAttributes.Birthplacestring
The birthplace of the candidate.
Value.PersonalAttributes.CurrentLocationstring
The current location listed on the resume.
Value.PersonalAttributes.CurrentSalaryobject
The current salary listed on the resume.
Value.PersonalAttributes.CurrentSalary.Currencystring
The three-letter currency, eg: USD
Value.PersonalAttributes.CurrentSalary.Amountdecimal
The amount of the salary (usually yearly when listed on a resume)
Value.PersonalAttributes.DateOfBirthobject
The date of birth given on the resume
Value.PersonalAttributes.DateOfBirth.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.PersonalAttributes.DateOfBirth.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.PersonalAttributes.DateOfBirth.FoundYearbool
True if the year was found in the text, otherwise false
Value.PersonalAttributes.DateOfBirth.FoundMonthbool
True if the month was found in the text, otherwise false
Value.PersonalAttributes.DateOfBirth.FoundDaybool
True if the day was found in the text, otherwise false
Value.PersonalAttributes.DrivingLicensestring
A driving license listed on the resume.
Value.PersonalAttributes.FamilyCompositionstring
The family composition.
Value.PersonalAttributes.FathersNamestring
The candidate's father's name listed on the resume.
Value.PersonalAttributes.Genderstring
The candidate's gender listed on the resume.
Value.PersonalAttributes.HukouCitystring
Used in Chinese resumes.
Value.PersonalAttributes.HukouAreastring
Used in Chinese resumes.
Value.PersonalAttributes.MaritalStatusstring
The marital status listed on the resume.
Value.PersonalAttributes.MothersMaidenNamestring
The candidate's mother's maiden name listed on the resume.
Value.PersonalAttributes.MotherTonguestring
The candidate's mother tongue (native language) listed on the resume.
Value.PersonalAttributes.NationalIdentitiesobject[]
Any national identities provided on the resume.
Value.PersonalAttributes.NationalIdentities[i].Numberstring
The national identity number.
Value.PersonalAttributes.NationalIdentities[i].Phrasestring
The national identity number.
Value.PersonalAttributes.Nationalitystring
The candidate's nationality listed on the resume.
Value.PersonalAttributes.PassportNumberstring
The candidate's passport number listed on the resume.
Value.PersonalAttributes.PreferredLocationstring
The candidate's preferred location listed on the resume.
Value.PersonalAttributes.RequiredSalaryobject
The candidate's required salary listed on the resume.
Value.PersonalAttributes.RequiredSalary.Currencystring
The three-letter currency, eg: USD
Value.PersonalAttributes.RequiredSalary.Amountdecimal
The amount of the salary (usually yearly when listed on a resume)
Value.PersonalAttributes.VisaStatusstring
The candidate's visa status listed on the resume.
Value.PersonalAttributes.WillingToRelocatestring
Whether the candidate is willing to relocate.
Value.Educationobject
The candidate's education history found on the resume.
Value.Education.HighestDegreeobject
The highest degree obtained by a candidate
Value.Education.HighestDegree.Nameobject
The name of the degree
Value.Education.HighestDegree.Name.Rawstring
The raw value found in the text.
Value.Education.HighestDegree.Name.Normalizedstring
The normalized value.
Value.Education.HighestDegree.Typestring
The type of degree.
Value.Education.EducationDetailsobject[]
All of the education details listed on a resume
Value.Education.EducationDetails[i].Idstring
The id of this education entry (one-based, so EDU-1 is the first, etc)
Value.Education.EducationDetails[i].Textstring
The raw text from the resume.
Value.Education.EducationDetails[i].SchoolNameobject
The name of the school attended
Value.Education.EducationDetails[i].SchoolName.Rawstring
The raw value found in the text.
Value.Education.EducationDetails[i].SchoolName.Normalizedstring
The normalized value.
Value.Education.EducationDetails[i].SchoolTypestring
The type of the school attended. One of:
- UNSPECIFIED
- lowerSchool
- highschool
- secondary
- trade
- professional
- vocational
- community
- college
- university
Value.Education.EducationDetails[i].Locationobject
The Country/Region/City of the school, if found
Value.Education.EducationDetails[i].Location.CountryCodestring
The 2-letter ISO 3166 country code.
Value.Education.EducationDetails[i].Location.PostalCodestring
The Postal or Zip code.
Value.Education.EducationDetails[i].Location.Regionsstring[]
The Regions/Districts/States.
Value.Education.EducationDetails[i].Location.Municipalitystring
The City/Municipality/Town.
Value.Education.EducationDetails[i].Location.StreetAddressLinesstring
Street address lines
Value.Education.EducationDetails[i].Location.GeoCoordinatesobject
If geocoding has been done, this is the lat/lon for the location.
Value.Education.EducationDetails[i].Location.Latitudedecimal
The latitude, in degrees.
Value.Education.EducationDetails[i].Location.Longitudedecimal
The longitude, in degrees.
Value.Education.EducationDetails[i].Location.Sourcestring
The geocoding source, such as Google or Bing.
Value.Education.EducationDetails[i].Degreeobject
The degree obtained (or worked toward)
Value.Education.EducationDetails[i].Degree.Nameobject
The name of the degree
Value.Education.EducationDetails[i].Degree..Name.Rawstring
The raw value found in the text.
Value.Education.EducationDetails[i].Degree.Name.Normalizedstring
The normalized value.
Value.Education.EducationDetails[i].Degree.Typestring
The type of degree.
Value.ResumeData.Education.EducationDetails[i].Degree.Typestring
These values are not very global-friendly, but the Parser does normalize all degrees to one of these pre-defined types. This list is sorted, as well as possible, by increasing level of education, although there are certainly ambiguities from one discipline to another, such as whether professional is above or below bachelors. Here are the possible values:
- lessThanHighSchool
- specialeducation
- someHighSchoolOrEquivalent
- ged
- certification
- vocational
- secondary
- highSchoolOrEquivalent
- someCollege
- HND_HNC_OrEquivalent
- ASc
- associates
- international
- professional
- postprofessional
- BSc
- bachelors
- somePostgraduate
- MBA
- MSc
- masters
- intermediategraduate
- doctorate
- postdoctorate
Value.Education.EducationDetails[i].Majorsstring[]
Any majors/areas of major focus.
Value.Education.EducationDetails[i].Minorsstring[]
Any minors/areas of minor focus.
Value.Education.EducationDetails[i].GPAobject
The GPA/marks listed on the resume
Value.Education.EducationDetails[i].GPA.Scorestring
The score found in the resume.
Value.Education.EducationDetails[i].GPA.ScoringSystemstring
The scoring system used on the resume.
Value.Education.EducationDetails[i].GPA.MaxScorestring
The max score in the scoring system.
Value.Education.EducationDetails[i].GPA.MinimumScorestring
The minimum score in the scoring system.
Value.Education.EducationDetails[i].GPA.NormalizedScoredecimal
Normalized GPA is a decimal value that is output only when a GPA has been provided. This value is normalized from 0.0 to 1.0, with 1.0 being the top mark, so that all GPAs across all scales can be compared, taking into account different min/max values and whether high or low numbers are ranked higher. For example:
- USA degree with GPA of 3.5 / 4.0 = 0.875
- German degree with 1.5 / 6.0 = 0.916
Value.Education.EducationDetails[i].LastEducationDateobject
Deprecated - use EndDate instead.
Value.Education.EducationDetails[i].LastEducationDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.Education.EducationDetails[i].LastEducationDate..IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.Education.EducationDetails[i].LastEducationDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.Education.EducationDetails[i].LastEducationDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.Education.EducationDetails[i].LastEducationDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.Education.EducationDetails[i].StartDateobject
The date education started
Value.Education.EducationDetails[i].StartDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.Education.EducationDetails[i].StartDate..IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.Education.EducationDetails[i].StartDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.Education.EducationDetails[i].StartDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.Education.EducationDetails[i].StartDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.Education.EducationDetails[i].EndDateobject
The date graduated or education ended
Value.Education.EducationDetails[i].EndDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.Education.EducationDetails[i].EndDate..IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.Education.EducationDetails[i].EndDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.Education.EducationDetails[i].EndDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.Education.EducationDetails[i].EndDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.Education.EducationDetails[i].Graduatedobject
Whether or not the candidate graduated.
Value.Education.EducationDetails[i].Graduated.Valuebool
Whether or not the candidate graduated
Value.Education.EducationDetails[i].Graduated.HasValuebool
True if this object has a value, otherwise false.
Value.EmploymentHistoryobject
The candidate's employment/work history found on the resume.
Value.EmploymentHistory.ExperienceSummarystring
A summary of all the work history with important calculated metadata
Value.EmploymentHistory.ExperienceSummary.Descriptionstring
A paragraph of text that summarizes the candidate's experience. This paragraph is generated based on other data points in the ExperienceSummary. It will be the same language as the resume for Czech, Dutch, English, French, German, Greek, Hungarian, Italian, Norwegian, Russian, Spanish, and Swedish. To always generate the summary in English, set "OutputFormat.AllSummariesInEnglish = True;" in the configuration string when parsing.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
Value.EmploymentHistory.ExperienceSummary.MonthsOfWorkExperienceinteger
The number of months of work experience as indicated by the range of start and end date values in the various jobs/positions in the resume. Overlapping date ranges are not double-counted. This value is NOT derived from text like "I have 15 years of experience".
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
Value.EmploymentHistory.ExperienceSummary.MonthsOfManagementExperienceinteger
The number of months of management experience as indicated by the range of start and end date values in the various jobs/positions in the resume that have been determined to be management-level positions. Overlapping date ranges are not double-counted. This value is NOT derived from text like "I have 10 years of management experience".
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
Value.EmploymentHistory.ExperienceSummary.ExecutiveTypestring
If ManagementScore is at least 30 (mid-level+), then the job titles are examined to determine the best category for the executive experience. One of:
- NONE
- ADMIN
- ACCOUNTING
- BUSINESS_DEV
- EXECUTIVE
- FINANCIAL
- GENERAL
- IT
- LEARNING
- MARKETING
- OPERATIONS
Value.EmploymentHistory.ExperienceSummary.AverageMonthsPerEmployerinteger
The average number of months a candidate has spent at each employer. Note that this number is per employer, not per job.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
Value.EmploymentHistory.ExperienceSummary.FulltimeDirectHirePredictiveIndexinteger
A score (0-100), where 0 means a candidate is more likely to have had (and want/pursue) short-term/part-time/temp/contracting jobs and 100 means a candidate is more likely to have had (and want/pursue) traditional full-time, direct-hire jobs
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
In order for this value to be accurate, you must have provided an accurate DocumentLastModified when you parsed this resume.
Value.EmploymentHistory.ExperienceSummary.ManagementStorystring
A paragraph of text that summarizes the candidate's management experience (in English).
Value.EmploymentHistory.ExperienceSummary.CurrentManagementLevelstring
Computed level of management for the current position. One of:
- low-or-no-level
- low-level
- mid-level
- somewhat high-level
- high-level
- executive-level
Value.EmploymentHistory.ExperienceSummary.ManagementScoreinteger
The highest score calculated from any of the position titles. The score is based on the wording of the title, not on the experience described within the position description.
0-29 = Low level
30-59 = Mid level
60+ = High level
0-29 = Low level
30-59 = Mid level
60+ = High level
Value.EmploymentHistory.Positionsobject[]
A list of jobs/positions found on the resume.
Value.EmploymentHistory.Positions[i].Idstring
The id of this position (one-based, so POS-1 is the first, etc)
Value.EmploymentHistory.Positions[i].Employerobject
The employer/company for this position. Will be null if IsSelfEmployed is null.
Value.EmploymentHistory.Positions[i].Employer.Nameobject
The name of the employer (and an accuracy probability).
Value.EmploymentHistory.Positions[i].Employer.NameRawstring
The raw value found in the text.
Value.EmploymentHistory.Positions[i].Employer.NameNormalizedstring
The normalized value.
Value.EmploymentHistory.Positions[i].Employer.NameProbabilitystring
The degree of certainty that the company name is accurate. One of:
- VeryUnlikely - recommend discarding
- Unlikely - recommend discarding
- Probable - recommend review
- Confident - no action needed
Value.EmploymentHistory.Positions[i].Employer.OtherFoundNameobject
Sometimes a second possible company name is found, or a department/organization within a company. This is that value, if it is found.
Value.EmploymentHistory.Positions[i].Employer.OtherFoundName.Rawstring
The raw value found in the text.
Value.EmploymentHistory.Positions[i].Employer.OtherFoundName.Normalizedstring
The normalized value.
Value.EmploymentHistory.Positions[i].Employer.Locationobject
The location/address of the employer.
Value.EmploymentHistory.Positions[i].Employer.Location.CountryCodestring
The 2-letter ISO 3166 country code.
Value.EmploymentHistory.Positions[i].Employer.Location.PostalCodestring
The Postal or Zip code.
Value.EmploymentHistory.Positions[i].Employer.Location.Regionsstring[]
The Regions/Districts/States.
Value.EmploymentHistory.Positions[i].Employer.Location.Municipalitystring
The City/Municipality/Town.
Value.EmploymentHistory.Positions[i].Employer.Location.StreetAddressLinesstring
Street address lines.
Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinatesobject
If geocoding has been done, this is the lat/lon for the location.
Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Latitudedecimal
The latitude, in degrees.
Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Longitudedecimal
The longitude, in degrees.
Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Sourcestring
The geocoding source, such as Google or Bing.
Value.EmploymentHistory.Positions[i].RelatedToByDatesstring[]
A list of other positions Ids that have overlapping dates with this Position.
Value.EmploymentHistory.Positions[i].RelatedToByCompanyNamestring[]
A list of other positions Ids that have the same Employer as this Position.
Value.EmploymentHistory.Positions[i].IsSelfEmployedbool
True if the candidate was self-employed at this job/position.
Value.EmploymentHistory.Positions[i].IsCurrentbool
True if the job/position is listed as current on the resume.
Value.EmploymentHistory.Positions[i].JobTitleobject
The job title for this position/job.
Value.EmploymentHistory.Positions[i].Employer.JobTitle.Rawstring
The raw text as it was found in the resume.
Value.EmploymentHistory.Positions[i].Employer.JobTitle.Normalizedstring
The normalized job title.
Value.EmploymentHistory.Positions[i].Employer.JobTitle.Probabilitystring
The degree of certainty that the job title value is accurate. One of:
- VeryUnlikely - recommend discarding
- Unlikely - recommend discarding
- Probable - recommend review
- Confident - no action needed
Value.EmploymentHistory.Positions[i].Employer.JobTitle.Variationsstring[]
Any variations of this job title that might be useful for matching.
Value.EmploymentHistory.Positions[i].StartDateobject
The start date listed for this position.
Value.EmploymentHistory.Positions[i].StartDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.EmploymentHistory.Positions[i].StartDate.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.EmploymentHistory.Positions[i].StartDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.EmploymentHistory.Positions[i].StartDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.EmploymentHistory.Positions[i].StartDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.EmploymentHistory.Positions[i].EndDateobject
The end date listed for this position
Value.EmploymentHistory.Positions[i].EndDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.EmploymentHistory.Positions[i].EndDate.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.EmploymentHistory.Positions[i].EndDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.EmploymentHistory.Positions[i].EndDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.EmploymentHistory.Positions[i].EndDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.EmploymentHistory.Positions[i].NumberEmployeesSupervisedobject
How many employees were supervised in this position/job.
Value.EmploymentHistory.Positions[i].NumberEmployeesSupervised.Valuebool
How many employees were supervised in this position/job.
Value.EmploymentHistory.Positions[i].NumberEmployeesSupervised.HasValuebool
True if this object has a value, otherwise false.
Value.EmploymentHistory.Positions[i].JobTypestring
The type of job. One of:
- directHire
- contract
- temp
- volunteer
- internship
- UNSPECIFIED
Value.EmploymentHistory.Positions[i].TaxonomyNamestring
The name of the skills taxonomy that this position was categorized as based on skills found in the job description.
Value.EmploymentHistory.Positions[i].SubTaxonomyNamestring
The name of the skills subtaxonomy that this position was categorized as based on skills found in the job description.
Value.EmploymentHistory.Positions[i].JobLevelstring
The level determined by length of experience and job titles. One of:
- Low Level
- Entry Level
- Experienced (non-manager)
- Senior (more than 5 years experience)
- Manager
- Senior Manager (more than 5 years management experience)
- Executive (VP, Dept Head)
- Senior Executive (President, C-level)
Value.EmploymentHistory.Positions[i].Descriptionstring
The job description.
Value.SkillsDataobject[]
All the skills found in the resume.
Value.SkillsData[i].Rootstring
The name of the skills list that these taxonomies belong to.
Value.SkillsData[i].Taxonomiesobject[]
The skills taxonomies found in a resume.
Value.SkillsData[i].Taxonomies[j].Idstring
The id of the skills taxonomy.
Value.SkillsData[i].Taxonomies[j].Namestring
The human-readable name.
Value.SkillsData[i].Taxonomies[j].SubTaxonomiesobject[]
The subtaxonomy children of this taxonomy (more specific groupings of skills).
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].SubTaxonomyIdstring
The id of the subtaxonomy.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].SubTaxonomyNamestring
The human-readable name of the subtaxonomy.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].PercentOfOverallinteger
The percent (0-100) of skills found in the subtaxonomy compared to all subtaxonomies.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].PercentOfParentinteger
The percent (0-100) of skills found in the subtaxonomy compared to other subtaxonomies in the parent taxonomy
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skillsobject[]
The skills from the subtaxonomy that were found.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].MonthsExperienceobject
Describes the amount of experience a candidate has with this skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].MonthsExperience.Valueinteger
Describes the amount of experience a candidate has with this skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].MonthsExperience.HasValuebool
True if this object has a value, otherwise false.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsedobject
Describes the date the candidate last used the skill (derived from position dates)
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsed.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsed.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsed.FoundYearbool
True if the year was found in the text, otherwise false
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsed.FoundMonthbool
True if the month was found in the text, otherwise false
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsed.FoundDaybool
True if the day was found in the text, otherwise false
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Idstring
The Id of the skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Namestring
The name of the skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].FoundInstring
Where the skill was found.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].ExistsInTextstring
Whether or not this skill was found verbatim in the text.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variationsobject[]
The variations (synonyms) of this skill that were found.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].MonthsExperienceobject
Describes the amount of experience a candidate has with this skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].MonthsExperience.Valueinteger
Describes the amount of experience a candidate has with this skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].MonthsExperience.HasValuebool
True if this object has a value, otherwise false.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsedobject
Describes the date the candidate last used the skill (derived from position dates)
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsed.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsed.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsed.FoundYearbool
True if the year was found in the text, otherwise false
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsed.FoundMonthbool
True if the month was found in the text, otherwise false
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsed.FoundDaybool
True if the day was found in the text, otherwise false
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Idstring
The Id of the skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Namestring
The name of the skill.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].FoundInstring
Where the skill was found.
Value.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].ExistsInTextstring
Whether or not this skill was found verbatim in the text.
Value.SkillsData[i].Taxonomies[j].PercentOfOverallinteger
The percent (0-100) of skills found in the document that belong to this taxonomy.
Value.Certificationsobject[]
Certifications found on a resume.
Value.Certifications[i].Namestring
The name of the certification.
Value.Certifications[i].MatchedFromListbool
True if Sovren found this by matching from a known list of certifications. False if Sovren found this by analyzing the context and determining it was a certification.
Value.ResumeData.Certifications[i].IsVariationbool
Sovren generates several possible variations for some certifications to be used in AI Matching. This greatly improves Matching, since different candidates have different ways of listing a certification. If this certification is a Sovren-created variation of a certification found on the resume, this property will be true.
Value.Licensesobject[]
Licenses found on a resume. These are professional licenses, not driving licenses. For driving licenses, see PersonalAttributes.
Value.Licenses[i].Namestring
The name of the license.
Value.Licenses[i].MatchedFromListbool
True if Sovren found this by matching from a known list of licensense. False if Sovren found this by analyzing the context and determining it was a license.
Value.Associationsobject[]
Associations/organizations found on a resume.
Value.Association[i].Organizationstring
The name of the association/organization.
Value.Association[i].Rolestring
The role the candidate held.
Value.Association[i].FoundInContextstring
The full text in which this association was found.
Value.LanguageCompetenciesobject[]
Any language competencies (fluent in, can read, can write, etc) found on the resume.
Value.LanguageCompetencies[i].Languagestring
The language name.
Value.LanguageCompetencies[i].LanguageCodestring
The two-letter ISO 639-1 code for the language.
Value.LanguageCompetencies[i].FoundInContextstring
The full text where Sovren found this language competency.
Value.MilitaryExperienceobject[]
Any military experience listed on the resume.
Value.MilitaryExperience[i].Countrystring
The country that the military belongs to.
Value.MilitaryExperience[i].Serviceobject
The branch/name/rank for this post/job.
Value.MilitaryExperience[i].Service.Namestring
The name of the military post/job.
Value.MilitaryExperience[i].Service.Branchstring
The branch of the military.
Value.MilitaryExperience[i].Service.Rankstring
he military rank of the candidate.
Value.MilitaryExperience[i].StartDateobject
The start date for this military post/job.
Value.MilitaryExperience[i].StartDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.MilitaryExperience[i].StartDate.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.MilitaryExperience[i].StartDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.MilitaryExperience[i].StartDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.MilitaryExperience[i].StartDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.MilitaryExperience[i].EndDateobject
The end date for this military post/job.
Value.MilitaryExperience[i].EndDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.MilitaryExperience[i].EndDate.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.MilitaryExperience[i].EndDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.MilitaryExperience[i].EndDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.MilitaryExperience[i].EndDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.MilitaryExperience[i].FoundInContextstring
The full text where Sovren found this military post/job in the resume.
Value.SecurityCredentialsobject[]
Any security credentials/clearances listed on the resume.
Value.SecurityCredentials[i].Namestring
The name of the credential/clearance.
Value.SecurityCredentials[i].FoundInContextstring
The full context of where Sovren found this clearance/credential.
Value.Referencesobject[]
References listed on a resume.
Value.References[i].ReferenceNameobject
The name of the reference.
Value.References[i].ReferenceName.FormattedNamestring
The name in a standard format.
Value.References[i].ReferenceName.Prefixstring
A prefix for a name, such as Dr.
Value.References[i].ReferenceName.GivenNamestring
The given (first) name.
Value.References[i].ReferenceName.MiddleNamestring
The middle name or initial.
Value.References[i].ReferenceName.FamilyNamestring
The family (last) name.
Value.References[i].ReferenceName.Suffixstring
A suffix for a name, such as Jr. or III.
Value.References[i].Titlestring
The job title of the reference.
Value.References[i].Companystring
The employer of the reference.
Value.References[i].Typestring
The type of reference.
Value.References[i].Locationobject
The physical location of the reference.
Value.References[i].Location.CountryCodestring
The 2-letter ISO 3166 country code.
Value.References[i].Location.PostalCodestring
The Postal or Zip code.
Value.References[i].Location.Regionsstring[]
The Regions/Districts/States.
Value.References[i].Location.Municipalitystring
The City/Municipality/Town.
Value.References[i].Location.StreetAddressLinesstring
Street address lines.
Value.References[i].Location.GeoCoordinatesobject
If geocoding has been done, this is the lat/lon for the location.
Value.References[i].Location.GeoCoordinates.Latitudedecimal
The latitude, in degrees.
Value.References[i].Location.GeoCoordinates.Longitudedecimal
The longitude, in degrees.
Value.References[i].Location.GeoCoordinates.Sourcestring
The geocoding source, such as Google or Bing.
Value.References[i].Telephonesobject[]
Phone numbers listed for the reference.
Value.References[i].Telephones[i].Rawstring
The raw value found in the text.
Value.References[i].Telephones[i].Normalizedstring
The normalized value.
Value.References[i].EmailAddressesstring[]
Email addresses listed for the reference.
Value.References[i].WebAddressesobject[]
Other web addresses listed for the reference.
Value.References[i].WebAddresses[i].Addressstring
The URL or username
Value.References[i].WebAddresses[i].Typestring
The type of address. One of:
- PersonalWebsite
- GitHub
- Skype
- StackOverflow
- Signal
- Quora
- ICQ
- Telegraph
- Telegram
- MeWe
- Parler
- Gab
- Unknown
Value.Achievementsstring[]
Any achievements listed on the resume.
Value.Trainingobject
Any training listed on the resume.
Value.Training.Textstring
The full text where we found all training history.
Value.Training.Trainingsobject[]
Information about each training history we found.
Value.Training.Trainings[i].Textstring
The text that was found on the resume.
Value.Training.Trainings[i].Entitystring
The name of the school or company where the training occurred.
Value.Training.Trainings[i].Qualificationsstring[]
Any text within the Text that is recognized as a qualification (such as DDS), degree (such as B.S.), or a certification (such as PMP). Each qualification is listed separately.
Value.Training.Trainings[i].StartDateobject
The date the training started.
Value.Training.Trainings[i].StartDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.Training.Trainings[i].StartDate.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.Training.Trainings[i].StartDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.Training.Trainings[i].StartDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.Training.Trainings[i].StartDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.Training.Trainings[i].EndDateobject
The date the training ended.
Value.Training.Trainings[i].EndDate.Datedate
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Value.Training.Trainings[i].EndDate.IsCurrentDatebool
True if this date represents '- current' and not an actual date
Value.Training.Trainings[i].EndDate.FoundYearbool
True if the year was found in the text, otherwise false
Value.Training.Trainings[i].EndDate.FoundMonthbool
True if the month was found in the text, otherwise false
Value.Training.Trainings[i].EndDate.FoundDaybool
True if the day was found in the text, otherwise false
Value.Hobbiesstring
Any hobbies listed on the resume.
Value.Patentsstring
Any patents listed on the resume.
Value.Publicationsstring
Any publications listed on the resume.
Value.SpeakingEngagementsstring
Any speaking engagements/appearances listed on the resume.
Value.ResumeMetadataobject
Metadata about the parsed resume.
Value.ResumeMetadata.PlainTextstring
The plain text that was used for parsing.
Value.ResumeMetadata.DocumentLanguagestring
The primary language of the parsed text. The value is one of the ISO 639-1 codes. When the language could not be automatically determined, it is reported as the special value Invariant/Unknown (iv). The two-letter ISO codes reported by the Parser, such as zh for Chinese, do not differentiate between language variants, such as Mandarin and Cantonese.
For a listing of languages and regions supported the most recent version, you can refer to parser tech specs.
For a listing of languages and regions supported the most recent version, you can refer to parser tech specs.
Value.ResumeMetadata.DocumentCulturestring
This is an ISO 3066 code that represents the actual cultural context regarding formatting of numbers, dates, character symbols, and so on. This value is usually a simple concatenation of the Language and Country codes, such as "en-US" for US English, but beware that CultureInfo can be set independently of Language and Country to achieve fine-tuned cultural control over parsing, so if you use this value you should not assume that it always matches the Language and Country.
Value.ResumeMetadata.ParserSettingsstring
The full parser settings that were used during parsing.
Value.ResumeMetadata.DocumentLastModifieddate
The last-revised/last-modified date that was provided for the document. This was used to calculate all of the important metrics about skills and jobs.
Value.ResumeMetadata.FoundSectionsobject[]
A list of sections found in the resume
Value.ResumeMetadata.FoundSections[i].FirstLineNumberinteger
The first line of the section (zero-based).
Value.ResumeMetadata.FoundSections[i].LastLineNumberinteger
The last line of the section (zero-based).
Value.ResumeMetadata.FoundSections[i].SectionTypestring
One of the following values: ARTICLES, AVAILABILITY, BOOKS, CERTIFICATIONS, CONFERENCE_PAPERS, CONTACT_INFO, EDUCATION, HOBBIES, IGNORE_DATA_AFTER, LANGUAGES, LICENSES, MILITARY, OBJECTIVE, OTHER_PUBLICATIONS, PATENTS, PERSONAL_INTERESTS_AND_ACCOMPLISHMENTS, PROFESSIONAL_AFFILIATIONS, QUALIFICATIONS_SUMMARY, REFERENCES, SECURITY_CLEARANCES, SKILLS, SPEAKING, SUMMARY, TRAINING, WORK_HISTORY, WORK_STATUS
Value.ResumeMetadata.FoundSections[i].HeaderTextFoundstring
The exact text that was used to identify the beginning of the section. If there was no text indicator and the location was calculated, then the value is "CALCULATED"
Value.ResumeMetadata.ResumeQualityobject[]
A list of quality assessments for the resume. These are very useful for providing feedback to candidates about why their resume did not parse properly. These can also be used to determine if a resume is 'high quality' enough to put into your system. More information is available in the Resume Quality Documentation
Value.ResumeMetadata.ResumeQuality[i].Levelstring
The level/severity of this assessment. One of:
- Suggested Improvements
- Data Missing
- Major Issues Found
- Fatal Problems Found
Value.ResumeMetadata.ResumeQuality[i].Findingsobject[]
A list of findings of the same severity/level.
Value.ResumeMetadata.ResumeQuality[i].Findings[j].QualityCodestring
A unique 3-digit code to identify what type of issue was found. See all possibilities here.
Value.ResumeMetadata.ResumeQuality[i].Findings[j].Identifiersstring[]
Areas in the resume where this issue was found or affected by this issue. These will be section indexes, work history position identifiers, etc.
Value.ResumeMetadata.ResumeQuality[i].Findings[j].Messagestring
A human-readable message explaining the issue that is being reported and possibly how to fix.
Value.ResumeMetadata.ReservedDataobject
Used by Sovren to redact PII.
Value.ResumeMetadata.ReservedData.Phonesstring[]
All phone numbers found in the resume.
Value.ResumeMetadata.ReservedData.Namesstring[]
All names found in the resume.
Value.ResumeMetadata.ReservedData.EmailAddressesstring[]
All email addresses found in the resume.
Value.ResumeMetadata.ReservedData.Urlsstring[]
All personal urls found in the resume.
Value.ResumeMetadata.ReservedData.OtherDatastring[]
Any other PII that should be redacted.
Value.ResumeMetadata.UserDefinedTagsstring[]
A list of User-Defined Tags that are assigned to this resume. These are used to filter search/match queries in the AI Matching Engine.
NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.
NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.