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 job order.
Value.CurrentJobIsManagementbool
Whether or not the job is a management position. Used by Sovren for AI Matching.
Value.HighestManagementScoreobject
The management score, or null. Used by Sovren for AI Matching.
Value.HighestManagementScore.Valueinteger
The management score.
Value.ManagementLevelstring
The management level. Used by Sovren for AI Matching. One of:
- None
- Low
- Mid
- High
Value.ExecutiveTypestring
What kind of executive position the job is, if any. Used by Sovren for AI Matching. One of:
- NONE
- ADMIN
- ACCOUNTING
- BUSINESS_DEV
- EXECUTIVE
- FINANCIAL
- GENERAL
- IT
- LEARNING
- MARKETING
- OPERATIONS
Value.MinimumYearsobject
The minimum years experience for the job, or null. Used by Sovren for AI Matching.
Value.MinimumYears.Valueinteger
The minimum years experience for the job.
Value.MaximumYearsobject
The maximum years experience for the job, or null. Used by Sovren for AI Matching.
Value.MaximumYears.Valueinteger
The maximum years experience for the job.
Value.MinimumYearsManagementobject
The minimum years of management experience, or null. Used by Sovren for AI Matching.
Value.MinimumYearsManagement.Valueinteger
The minimum years of management experience.
Value.MaximumYearsManagementobject
The maximum years of management experience, or null. Used by Sovren for AI Matching.
Value.MaximumYearsManagement.Valueinteger
The maximum years of management experience.
Value.RequiredDegreestring
The required educational degree, if listed. Used by Sovren for AI Matching.
Value.JobDescriptionstring
The full job description.
Value.JobRequirementsstring
Full text of any requirements listed by the job.
Value.Benefitsstring
Full text of any benefits listed by the job.
Value.EmployerDescriptionstring
Full text of any employer description listed by the job.
Value.StartDateobject
The start date of the job.
Value.StartDate.Valuedate
The value of the start date of the job.
Value.JobTitlesobject
The job titles found in the job. Used by Sovren for AI Matching.
Value.JobTitles.MainJobTitlestring
The main/overall job title.
Value.JobTitles.JobTitlestring[]
All job titles found in the job description.
Value.JobTitles.NormalizedProfessionobject
If
ProfessionsSettings.Normalize was set to true, this will be populated for the most recent 3 positions.Value.JobTitles.NormalizedProfession.Professionobject
Object containing the details of the profession concept.
Value.JobTitles.NormalizedProfession.Profession.CodeIdint
The code id of the profession concept.
Value.JobTitles.NormalizedProfession.Profession.Descriptionstring
The description of the profession concept.
Value.JobTitles.NormalizedProfession.Groupobject
The object of the group to which the profession concept belongs.
Value.JobTitles.NormalizedProfession.Group.CodeIdint
The code id of the group to which the profession concept belongs.
Value.JobTitles.NormalizedProfession.Group.Descriptionstring
The description of the group to which the profession concept belongs.
Value.JobTitles.NormalizedProfession.Classobject
The object of the class to which the profession concept belongs.
Value.JobTitles.NormalizedProfession.Class.CodeIdint
The code id of the class to which the profession concept belongs.
Value.JobTitles.NormalizedProfessionClass.Descriptionstring
The description of the class to which the profession concept belongs.
Value.JobTitles.NormalizedProfession.ISCOobject
The object of the ISCO profession concept
Value.JobTitles.NormalizedProfession.ISCO.Versionstring
The version of the ISCO taxonomy
Value.JobTitles.NormalizedProfession.ISCO.CodeIdint
The code if of the ISCO profession concept
Value.JobTitles.NormalizedProfession.ISCO.Descriptionstring
The description of the ONET profession concept
Value.JobTitles.NormalizedProfession.ONETobject
The object of the ONET profession concept
Value.JobTitles.NormalizedProfession.ONET.Versionstring
The version of the ONET taxonomy
Value.JobTitles.NormalizedProfession.ONET.CodeIdstring
The code id of the ONET profession concept
Value.JobTitles.NormalizedProfession.ONET.Descriptionstring
The description of the ONET profession concept
Value.JobTitles.NormalizedProfession.Confidence.Descriptionfloat
Overall confidence that the input job title was normalized to the correct profession concept
Value.EmployerNamesobject
The employer names found in the job.
Value.EmployerNames.MainEmployerNamestring
The main/overall employer name.
Value.EmployerNames.EmployerNamestring[]
All employer names found in a job description.
Value.Degreesobject[]
The educational degrees found listed in the job. Used by Sovren for AI Matching.
Value.Degrees[i].Namestring
The name of the educational degree.
Value.Degrees[i].Typestring
The type of the educational degree.
Value.Degrees[i].LocalEducationLevelstring
The normalized, local education level based on the job's country. Returns the Code ID from the table below.
| Code ID | Description |
|---|---|
| AT_0 | Unbekannt |
| AT_1 | Volksschule |
| AT_10 | Fachhochschule |
| AT_11 | Akademie |
| AT_12 | Universität |
| AT_13 | Post-Akademische Ausbildung |
| AT_14 | Dissertation |
| AT_2 | Hauptschule |
| AT_3 | AHS Unterstufe |
| AT_4 | Lehre |
| AT_5 | BMS |
| AT_6 | BHS |
| AT_7 | AHS Oberstufe |
| AT_8 | Werkmeister- und Meisterschule |
| AT_9 | Kolleg |
| BE_0 | Onbekend |
| BE_1 | Doctoraat |
| BE_10 | Beroepssecundair onderwijs |
| BE_11 | Technisch secundair onderwijs |
| BE_12 | Lager onderwijs |
| BE_13 | Andere |
| BE_14 | Hoger beroepsonderwijs |
| BE_3 | Master |
| BE_4 | Bachelor/Master |
| BE_5 | Academische/Professionele bachelor |
| BE_6 | Academische bachelor |
| BE_7 | Professionele bachelor |
| BE_8 | Algemeen secundair onderwijs |
| BE_9 | Kunstsecundair onderwijs |
| BR_0 | Desconocido |
| BR_1 | Ensino fundamentele |
| BR_2 | Ensino secundário |
| BR_3 | Licenciatura |
| BR_4 | Mestrado |
| BR_5 | Doutoramento |
| CA_0 | Unknown |
| CA_1 | High School |
| CA_2 | Vocational Certificate |
| CA_3 | Bachelor's Degree |
| CA_4 | Master's Degree |
| CA_5 | Ph.D. |
| CH_0 | Andere/Unbekannt |
| CH_1 | Primarschule |
| CH_10 | Post-doc |
| CH_2 | Sekundarschule |
| CH_3 | Berufliche Grundbildung |
| CH_4 | Allgemeinbildende Schulen |
| CH_5 | Höhere Berufsbildung |
| CH_6 | Hochschule |
| CH_7 | Nachdiplomausbildung |
| CH_8 | Masterstudium |
| CH_9 | Doktorat |
| CN_0 | 无要求 |
| CN_1 | 小学 |
| CN_2 | 中学 |
| CN_3 | 职业教育 |
| CN_4 | 大学 |
| CN_5 | 硕士 |
| CN_6 | 博士 |
| CZ_0 | Unknown |
| CZ_1 | Základní škola |
| CZ_2 | SOU |
| CZ_3 | Gymnázium |
| CZ_4 | DiS / Vos |
| CZ_5 | Bakalář |
| CZ_6 | Magistr |
| CZ_7 | Doctorat |
| DE_0 | Unbekannt |
| DE_1 | Grundschule |
| DE_2 | Hauptschule |
| DE_3 | Realschule |
| DE_4 | Gymnasium |
| DE_5 | Fachschule/Berufsausbildung |
| DE_6 | Meister |
| DE_7 | Bachelor |
| DE_8 | Master |
| DE_9 | Dissertation |
| DK_0 | Unknown |
| DK_1 | Folkeskole |
| DK_2 | Gymnasie |
| DK_3 | Professional Higher |
| DK_4 | Bachelor |
| DK_5 | Candidatus / Master |
| DK_6 | Ph.D. |
| DK_7 | Universitet |
| ES_0 | Desconocido |
| ES_1 | Bachillerato |
| ES_2 | Formación Profesional |
| ES_3 | Grado |
| ES_4 | Licenciatura |
| ES_5 | Doctorado |
| FI_0 | No Degree |
| FI_1 | Basic Education |
| FI_10 | PhD |
| FI_2 | Vocational Upper Secondary |
| FI_3 | Upper Secondary School |
| FI_4 | University Degree |
| FI_5 | Bachelor Polytechnic |
| FI_6 | Bachelor |
| FI_7 | Engineer |
| FI_8 | Master |
| FI_9 | Pre-doctoral Degree |
| FR_0 | Unknown |
| FR_1 | Elementary |
| FR_10 | Bac+3/+4 |
| FR_11 | Bac+3/+5 |
| FR_12 | Bac+4 |
| FR_13 | Bac+4/+5 |
| FR_14 | Bac+5 |
| FR_15 | Bac+8 |
| FR_2 | BEP/CAP |
| FR_3 | Bac Pro |
| FR_4 | Bac |
| FR_5 | Bac+2 |
| FR_6 | Bac+2/+3 |
| FR_7 | Bac+2/+4 |
| FR_8 | Bac+2/+5 |
| FR_9 | Bac+3 |
| GB_0 | Unknown |
| GB_1 | Post-Graduate qualification |
| GB_2 | Master's degree |
| GB_3 | Bachelor's degree |
| GB_4 | Professional qualification |
| GB_5 | HND/HNC or equivalent |
| GB_6 | Vocational qualification (NVQ/VRQ/QCF) |
| GB_7 | 'A' Level or equivalent |
| GB_8 | GCSE or equivalent |
| GB_9 | Other |
| GR_0 | Unknown |
| GR_1 | Primary School |
| GR_2 | Lower Secondary School |
| GR_3 | Upper Secondary School |
| GR_4 | Bachelor |
| GR_5 | Master |
| GR_6 | Doctorate |
| HR_0 | Bez diplome |
| HR_1 | Osnovna škola |
| HR_2 | Srednja stručna sprema |
| HR_3 | Viša stručna sprema |
| HR_4 | Visoka stručna sprema |
| HR_5 | Poslijediplomski znanstveni magistarski studiji |
| HR_6 | Doktor znanosti |
| HU_0 | Unknown |
| HU_1 | Általános Iskola |
| HU_2 | Szakiskola |
| HU_3 | Gimnázium |
| HU_4 | Főiskola |
| HU_5 | Egyetem- BSc, BA |
| HU_6 | Egyetem- MSc, MA, osztatlan |
| HU_7 | Posztgraduális képzés |
| HU_8 | PhD |
| IT_0 | Corsi |
| IT_1 | Scuola della infanzia |
| IT_2 | Scuola elementare |
| IT_3 | Scuola secondaria di primo grado |
| IT_4 | Scuola secondaria di secondo grado |
| IT_5 | Laurea triennale |
| IT_6 | Master I livello |
| IT_7 | Laurea specialistica |
| IT_8 | Master II livello |
| IT_9 | Dottorato di ricerca |
| JP_0 | リクエストなし |
| JP_1 | 小学校 |
| JP_2 | 中等学校 |
| JP_3 | 職業教育 |
| JP_4 | 大学 |
| JP_5 | マスター |
| JP_6 | 博士号 |
| NL_0 | Onbekend |
| NL_1 | Elementair |
| NL_10 | MBO/HBO |
| NL_11 | HBO |
| NL_12 | HBO/WO |
| NL_13 | WO |
| NL_14 | Post WO |
| NL_2 | VMBO |
| NL_3 | VMBO/MBO |
| NL_4 | Mavo/VMBO |
| NL_5 | VMBO/Havo |
| NL_6 | HAVO |
| NL_7 | HAVO/VWO |
| NL_8 | Vwo |
| NL_9 | MBO |
| NO_0 | Unknown |
| NO_1 | Primary School |
| NO_2 | Lower Secondary School |
| NO_3 | Upper Secondary School |
| NO_4 | Vocational Education |
| NO_5 | Bachelor |
| NO_6 | Master |
| NO_7 | Doctorate |
| NO_8 | University |
| PL_0 | Unknown |
| PL_1 | Szkola Podstawowa |
| PL_2 | Gimnazjum |
| PL_3 | Liceum |
| PL_4 | Bachelor |
| PL_5 | Magister |
| PL_6 | Doktor |
| PT_0 | Desconocido |
| PT_1 | Ensino fundamentele |
| PT_2 | Ensino medio |
| PT_3 | Licenciatura |
| PT_4 | Mestre |
| PT_5 | Doutor |
| RO_0 | Unknown |
| RO_1 | Scoala Primara |
| RO_2 | Gimnaziu |
| RO_3 | Liceu |
| RO_4 | Scoala Postliceala |
| RO_5 | Diplomă de Licenţă |
| RO_6 | Master |
| RO_7 | PhD |
| RU_0 | Unknown |
| RU_1 | Primary school |
| RU_2 | Secondary school |
| RU_3 | Prof. Qualification |
| RU_4 | Bachelor |
| RU_5 | Master |
| RU_6 | PhD |
| SE_0 | Unknown |
| SE_1 | Grundskola |
| SE_2 | Gymnasieskola |
| SE_3 | Högskolexamen |
| SE_4 | Kandidat |
| SE_5 | Master |
| SE_6 | Universitet-Licenciat-PhD |
| SI_0 | Brez stopnje |
| SI_1 | Osnovnošolska izobrazba |
| SI_2 | Srednješolska izobrazba |
| SI_3 | Dodiplomski študij |
| SI_4 | Magister |
| SI_5 | Magisterij znanosti |
| SI_6 | Doktor znanosti |
| SK_0 | Unknown |
| SK_1 | Základné Vzdelanie |
| SK_2 | Stredoškolské Vzdelanie Alebo Odborné Vyučenie |
| SK_3 | Vysokoškolské/Univerzitné Vzdelanie |
| SK_4 | Postgraduálne Štúdium |
| TR_0 | Diğer/Bilinmiyor |
| TR_1 | İlköğretim |
| TR_2 | Lise |
| TR_3 | Önlisans |
| TR_4 | Lisans |
| TR_5 | Yüksek Lisans |
| TR_6 | Doktora |
| TR_7 | Doktora sonrası |
| US_1 | Post-Doctorate Qualification |
| US_2 | PhD |
| US_3 | Master |
| US_4 | Bachelor |
| US_5 | Associate Degree |
| US_6 | Vocational Certificate |
| US_7 | College |
| US_8 | High School |
| US_9 | Unknown |
Value.SchoolNamesstring[]
Any school names listed in the job.
Value.CertificationsAndLicensesstring[]
Any certifications/licenses listed in the job. Used by Sovren for AI Matching.
Value.Skillsobject
Skills output when version 2 of the taxonomy is utilized.
Value.Skills.Rawobject[]
Array of skills exactly as found in the plain text of the document.
Value.Skills.Raw[i].Namestring
The exact skill text extracted from the document.
Value.Skills.Raw[i].Requiredbool
True if this skill was listed as 'required' on the job description.
Value.Skills.Normalizedobject
Normalized skills output when version 2 of the taxonomy is utilized and
SkillsSettings.Normalize is set to true.Value.Skills.Normalized[i].Namestring
Name of the normalized skill
Value.Skills.Normalized[i].Typestring
Type of skill. Possible values are
Professional, IT, or SoftValue.Skills.Normalized[i].Idstring
Id of this skill in the skills taxonomy
Value.Skills.Normalized[i].Requiredbool
True if this skill was listed as 'required' on the job description.
Value.Skills.Normalized[i].RawSkillsstring[]
Array of raw skills that were extracted that normalized to this skill.
Value.Skills.RelatedProfessionClassesobject
Professions most related to the document. Only output if version 2 of the skills taxonomy is utilized and
SkillsSettings.Normalize is set to true.Value.Skills.RelatedProfessionClasses.Namestring
Name of the related profession
Value.Skills.RelatedProfessionClasses.Idstring
Id of the related profession
Value.Skills.RelatedProfessionClasses.Percentint
Percent of overall document that relates to this profession
Value.Skills.RelatedProfessionClasses.Groupsobject[]
Array of objects representing groups of professions
Value.Skills.RelatedProfessionClasses.Groups[i].Namestring
Name of the profession group
Value.Skills.RelatedProfessionClasses.Groups[i].Idstring
Id of the profession group
Value.Skills.RelatedProfessionClasses.Groups[i].Percentint
Percent of overall document described by this profession group. All groups across all classes will add up to 100%.
Value.Skills.RelatedProfessionClasses.Groups[i].NormalizedSkillsstring[]
Array of normalized skills associated to this profession group.
Value.LanguageCodesstring[]
Any languages listed in the job. Used by Sovren for AI Matching.
Value.CurrentLocationobject
The location of the job, if listed. If no job location is found, this is the location of the company, if listed.
Value.CurrentLocation.CountryCodestring
The 2-letter ISO 3166 country code.
Value.CurrentLocation.PostalCodestring
The Postal or Zip code.
Value.CurrentLocation.Regionsstring[]
The Regions/Districts/States.
Value.CurrentLocation.Municipalitystring
The City/Municipality/Town.
Value.CurrentLocation.StreetAddressLinesstring
Street address lines.
Value.CurrentLocation.GeoCoordinatesobject
If geocoding has been done, this is the lat/lon for the location.
Value.CurrentLocation.GeoCoordinates.Latitudedecimal
The latitude, in degrees.
Value.CurrentLocation.GeoCoordinates.Longitudedecimal
The longitude, in degrees.
Value.CurrentLocation.GeoCoordinates.Sourcestring
The geocoding source, such as Google or Bing.
Value.ApplicationDetailsobject
Information about the application process.
Value.ApplicationDetails.ApplicationDescriptionstring
Full text description of the application process.
Value.ApplicationDetails.ContactPersonstring
Full name of the main contact person for the application.
Value.ApplicationDetails.ContactPhonestring
Normalized phone of the organization with international calling prefix. Can contain multiple values (concatenated by comma).
Value.ApplicationDetails.ContactEmailstring
Displayable email of the organization. Can contain multiple values (concatenated by comma).
Value.ApplicationDetails.Websitestring
Validated and normalized displayable website of the organization. Can contain multiple values (concatenated by comma)
Value.ApplicationDetails.ApplicationDeadlineDate
Deadline to apply for the job.
Value.ApplicationDetails.PostedDateDate
Date the job was posted.
Value.ApplicationDetails.ReferenceNumberstring
Any reference number found for the job application.
Value.Salaryobject
The salary found for the position
If no lexical cues are available from the vacancy, the time scale is guessed based on predefined salary ranges. Here are some rough salary ranges (note: country-specific conditions may apply):
If no lexical cues are available from the vacancy, the time scale is guessed based on predefined salary ranges. Here are some rough salary ranges (note: country-specific conditions may apply):
- 1 or 2 digits salary (9, 12): hourly
- 3 or 4 digits salary (3800, 5000): monthly
- 5 digit salary (38000, 50000): yearly
Value.Salary.Minimumobject
The normalized minimum yearly salary.
Value.Salary.MinimumValueinteger
The value of the normalized minimum yearly salary.
Value.Salary.Maximumobject
The normalized maximum yearly salary.
Value.Salary.MaximumValueinteger
The value of the normalized maximum yearly salary.
Value.Salary.Currencystring
Currency code (ISO 4217) applied to the
Minimum and MaximumValue.MinimumWorkingHoursobject
The minimum number of working hours per week, or null.
Value.MinimumWorkingHours.Valueinteger
The minimum number of working hours per week.
Value.MaximumWorkingHoursobject
The maximum number of working hours per week, or null.
Value.MaximumWorkingHours.Valueinteger
The maximum number of working hours per week.
Value.WorkingHoursstring
The type of working hours. One of:
- regular
- irregular
Value.IsRemotebool
Whether or not the position is remote. Includes fulltime, partial and temporary remote working opportunities.
Value.DriversLicensesstring[]
Any drivers license requirements.
Value.EmploymentTypestring
The type of employment. One of:
- unspecified
- fulltime
- parttime
- fulltime/parttime
Value.ContractTypestring
The contract type. One of:
- unspecified
- permanent
- temporary
- possibly_permanent
- interim
- franchise
- side
- internship
- voluntary
- freelance
- apprenticeship
- assisted
Value.TermsOfIntereststring[]
Terms of interest listed in the job.
Value.Ownersstring[]
Any owners of the job posting, if listed.
Value.SkillsDataobject[]
Deprecated. Use v2 skills taxonomy and its associated Skills output.
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].PercentOfOverallinteger
The percent (0-100) of skills found in the document that belong to this taxonomy.
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].Requiredbool
True if this skill was listed as 'required' on the job description.
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].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].Requiredbool
True if this skill was listed as 'required' on the job description.
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].ExistsInTextstring
Whether or not this skill was found verbatim in the text.
Value.JobMetadataobject
Metadata about the parsed job
Value.JobMetadata.PlainTextstring
The plain text that was used for parsing.
Value.JobMetadata.DocumentLanguagestring
The two-letter ISO 639-1 code for the language the document was written in.
Value.JobMetadata.DocumentCulturestring
The xx-XX language/culture value for the parsed document.
Value.JobMetadata.ParserSettingsstring
The full parser settings that were used during parsing.
Value.JobMetadata.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.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.