Parse a Resume🔗︎
| HTTP Verb | Path |
|---|---|
| POST | /v10/parser/resume |
Parse a single Resume/CV.
Info
- You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
- By default, our resume parser ensures an optimal balance between parsing accuracy and speed. If you have specific preferences, please contact sales@textkernel.com
- This service is designed to parse resumes/CVs. It assumes that all files passed to it are resumes/CVs. It does not attempt to detect whether a document is a resume/CV or not. It should not be used to try to extract information from other types of documents.
- This service supports all commercially viable document formats used for text documents (image formats are not supported). The service does not support parsing of image files (such as TIFF, JPG) or scanned images within supported document file formats. Always send the original file, not the result of copy/paste, not a conversion by some other software, not a scanned image, and not a version marked up with recruiter notes or other non-resume information. Be aware that if you pass garbage into the service, then you are likely to get garbage out. The best results are always obtained by parsing the original resume/CV file.
- In order to provide parsing for a wide range of languages, the parser does not provide low-usage fields for some languages.
- If you are running batch transactions (i.e. iterating through files in a folder), make sure that you do not try to reparse a file if you get an exception back from the service since you will get the same result each time and credits will be deducted from your account.
- Batch transactions must adhere to our Acceptable Use Policy.
Scope of use🔗︎
FlexRequests are of experimental nature. Therefore FlexRequests may not always provide accurate or reliable results. Textkernel gives no guarantees or warranties of any kind with the use of FlexRequests, nor does it accept any liability for its use. It is your sole responsibility to use FlexRequests in a responsible and ethical manner, not to use it for harmful, malicious or unethical purposes and to ensure that the use of FlexRequests aligns with applicable laws and regulations.
Request Body🔗︎
DocumentAsBase64String 🔗︎ string required
DocumentAsBase64String🔗︎
A Base64 encoded string of the resume file bytes. This should use the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). .NET users can use the Convert.ToBase64String(byte[]) method.
SkillsSettings 🔗︎ object
SkillsSettings🔗︎
Enable skills normalization and enhanced candidate summarization, and specify the version of the skills taxonomy for this parsing transaction.
SkillsSettings properties
Normalize 🔗︎ bool
Normalize🔗︎
When true:
- Raw skills will be normalized. These will be output under
Value.ResumeData.Skills.Normalized. Read more about the benefits of using a skills taxonomy. - An enhanced candidate summary is generated, leveraging the taxonomy structure to relate skills to profession groups.
- When
TaxonomyVersion(see below) is set to (or defaults to)V2, additional charges apply.
This setting has no effect when TaxonomyVersion is set to (or defaults to) V1.
TaxonomyVersion 🔗︎ string
TaxonomyVersion🔗︎
Specifies the version of the skills taxonomy to use. One of:
V1(Deprecated) - This is the default for old accounts. Will be removed in a future release.V2- This is the default for new accounts, and must be explicitly set if you have access to V1 and V2.
Benefits of V2 include:
- 2x larger skills taxonomy, updated frequently based on real-world data.
- 15-40% higher accuracy of extracted skills.
- Better clustering of skill synonyms.
- Distinguish skill types (IT / Professional / Soft).
- Improved candidate summary.
- Compatibility with the taxonomy used in Textkernel's Skills Intelligence APIs and Jobfeed, enabling standardization of taxonomies across all of your data and benchmarking against jobs posted online.
ProfessionsSettings 🔗︎ object
ProfessionsSettings🔗︎
Enable normalization of job titles using our proprietary taxonomy and international standards.
ProfessionsSettings properties
Normalize 🔗︎ bool
Normalize🔗︎
When true, the most recent 3 job titles will be normalized. This includes a proprietary value from our profession taxonomy, plus ONET and ISCO mappings. Read more about the benefits of using a professions taxonomy.
When enabling professions normalization, additional charges apply.
The following languages are supported: English, Chinese (Simplified), Dutch, French, German, Italian, Polish, Portuguese, and Spanish. For documents in other languages, no normalized values will be returned.
For Textkernel Search & Match, normalized professions are automatically indexed and used when profession normalization is enabled during parsing (through IndexingOptions). To leverage profession normalization for user-created searches, enable profession normalization at query time.
The professions taxonomy and the mappings are compatible with the taxonomies used in Textkernel's Skills Intelligence APIs and Jobfeed, enabling standardization of taxonomies across all of your data and benchmarking against jobs posted online.
DocumentLastModified 🔗︎ string required
DocumentLastModified🔗︎
Mandatory date, in YYYY-MM-DD format, so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" or similar. To find out why this is so important and how to calculate/find it, read here.
OutputHtml 🔗︎ bool
OutputHtml🔗︎
When true, the original file is converted to HTML and stored in the Html property.
OutputRtf 🔗︎ bool
OutputRtf🔗︎
When true, the original file is converted to RTF and stored in the Rtf property.
OutputPdf 🔗︎ bool
OutputPdf🔗︎
When true, the original file is converted to PDF and stored in the Pdf property as a byte array.
UseLLMParser 🔗︎ bool
UseLLMParser🔗︎
When true, and the document is English, the LLM parser will be used. See here for more information.
OutputCandidateImage 🔗︎ bool
OutputCandidateImage🔗︎
When true, if the document contains inline images, the image that is most likely to be a photo of the candidate is returned as a byte array.
Configuration 🔗︎ string Deprecated
Configuration🔗︎
This feature is not recommended and only available as an add-on. Please reach out to sales@textkernel.com.
Optional parser configuration string to be used for parsing. If not specified, the default parser configuration will be used.
GeocodeOptions 🔗︎ object
GeocodeOptions🔗︎
Get or insert geocode coordinate values (latitude/longitude) during the parse transaction.
GeocodeOptions properties
IncludeGeocoding 🔗︎ bool
IncludeGeocoding🔗︎
When set to true we will automatically geocode the address that is parsed out leveraging an api call to our /geocode endpoint, and thus will be charged accordingly. This parameter defaults to false.
Provider 🔗︎ string
Provider🔗︎
The Provider you wish to use to geocode the postal address (current options are "Google", "Bing", or "None"). If not specified, we will default to Google. If you are just trying to update the postal address in the document, please set this to "None". If passing "Google" or "Bing", ProviderKey is requried.
ProviderKey 🔗︎ string
ProviderKey🔗︎
The Provider Key for the specified Provider. If using Bing you must specify your own provider key.
PostalAddress 🔗︎ object
PostalAddress🔗︎
The postal address you wish to geocode. For best results, specify as many of the PostalAddress fields as possible. If provided, this address will be used to get the geocode coordinates instead of the address included in the ParsedDocument (if present), however, the address in the ParsedDocument will not be modified.
PostalAddress properties
CountryCode 🔗︎ string
CountryCode🔗︎
The ISO 3166-1 alpha-2 code indicating the country for the postal address.
GeoCoordinates 🔗︎ object
GeoCoordinates🔗︎
The geographic coordinates (latitude/longitude) for your postal address. Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed document. If provided, these values will be inserted into your ParsedDocument and the address included in the ParsedDocument (if present), will not be modified.
GeoCoordinates properties
IndexingOptions 🔗︎ object
IndexingOptions🔗︎
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions.
Skills Normalization must be included to index documents using V2 Skills Taxonomy. These algorithms ignore raw skills and only consider the normalized skill concepts for skills category scoring. This leads to improved scoring and ranking because normalization produces less false negatives than simple exact keyword matching.
IndexingOptions properties
IndexId 🔗︎ string
IndexId🔗︎
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions. This determines what index to place the parsed document in. This is case-insensitive.
DocumentId 🔗︎ string
DocumentId🔗︎
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions. This determines what id to give to the parsed document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.
FlexRequests 🔗︎ object[]
FlexRequests🔗︎
Custom requests to ask during parsing. See the overview documentation for more details.
FlexRequests properties
Identifier 🔗︎ string required
Identifier🔗︎
Unique field name to be returned alongside the reply in the response
SkillsData 🔗︎ string[] Deprecated
SkillsData🔗︎
This feature is not recommended and only available as an add-on. Please reach out to sales@textkernel.com.
String[] of your custom skills list names and the Textkernel "builtin" skills list. If no list is provided the Textkernel builtin skills list will be used. The parser automatically detects language and looks for a corresponding skills list in that language, if no match is found this list is ignored.
NormalizerData 🔗︎ string Deprecated
NormalizerData🔗︎
This feature is not recommended and only available as an add-on. Please reach out to sales@textkernel.com.
Name of your custom normalization data file. If no list is provided the Textkernel builtin skills list will be used (english only). When using custom normalization files the language to be used is determined by the Parser (the default fall back language is English if the Parser cannot find a match).
Sample JSON
{
"DocumentAsBase64String": "",
"SkillsSettings": {
"Normalize": false,
"TaxonomyVersion": ""
},
"ProfessionsSettings": {
"Normalize": false,
"Version": {
"ONET": "2019"
}
},
"DocumentLastModified": "",
"OutputHtml": false,
"OutputRtf": false,
"OutputPdf": false,
"UseLLMParser": false,
"OutputCandidateImage": false,
"Configuration": "",
"GeocodeOptions": {
"IncludeGeocoding": false,
"Provider": "",
"ProviderKey": "",
"PostalAddress": {
"CountryCode": "",
"PostalCode": "",
"Region": "",
"Municipality": "",
"AddressLine": ""
},
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0
}
},
"IndexingOptions": {
"IndexId": "",
"DocumentId": "",
"UserDefinedTags": [
""
]
},
"FlexRequests": [
{
"Prompt": "",
"Identifier": "",
"DataType": "",
"EnumerationValues": [
""
]
}
],
"SkillsData": [
""
],
"NormalizerData": ""
}
Response Body🔗︎
Info 🔗︎ object
Info🔗︎
Explains the outcome of the transaction.
Info properties
Code 🔗︎ string
Code🔗︎
| Code | Description |
|---|---|
Success |
Successful transaction |
ConversionException |
There was an issue converting the document |
MissingParameter |
A required parameter wasn't provided |
InvalidParameter |
A parameter was incorrectly specified |
Timeout |
The transaction reached its timeout limit |
AuthenticationError |
An error occurred with the credentials provided |
TransactionId 🔗︎ string
TransactionId🔗︎
The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.
EngineVersion 🔗︎ string
EngineVersion🔗︎
The version of the parsing/matching engine running under-the-hood.
TotalElapsedMilliseconds 🔗︎ integer
TotalElapsedMilliseconds🔗︎
How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
TransactionCost 🔗︎ decimal
TransactionCost🔗︎
How many credits the transaction costs.How many credits the transaction costs.
CustomerDetails 🔗︎ object
CustomerDetails🔗︎
Information about the customer who made the API call.
CustomerDetails properties
CreditsRemaining 🔗︎ decimal
CreditsRemaining🔗︎
The number of credits remaining to be used by the account.
Value 🔗︎ object
Value🔗︎
Contains response data for the transaction.
Value properties
ParsingResponse 🔗︎ object
ParsingResponse🔗︎
The status of the parse transaction.
ParsingResponse properties
Code 🔗︎ string
Code🔗︎
| Code | Description |
|---|---|
Success |
Successful transaction |
WarningsFoundDuringParsing |
Parsing was successful. This is not an error code. This is an advanced level message about the document, not about the parsing. For more information, refer to the ResumeQuality section in the parsed document output and to the documentation here. |
PossibleTruncationFromTimeout |
The timeout occurred before the document was finished parsing which can result in truncation |
Timeout |
The transaction reached its timeout limit |
ConversionException |
There was an issue converting the document |
GeocodeResponse 🔗︎ object
GeocodeResponse🔗︎
If geocoding was requested in the ParseOptions.GeocodeOptions the status of the geocode transaction will be output here.
GeocodeResponse properties
Code 🔗︎ string
Code🔗︎
| Code | Description |
|---|---|
Success |
Successful transaction |
MissingParameter |
A required parameter wasn't provided |
InvalidParameter |
A parameter was incorrectly specified |
InsufficientData |
The address provided doesn't have enough granularity to be geocoded effectively |
CoordinatesNotFound |
The geocoding provider couldn't find any coordinates matching the provided address |
IndexingResponse 🔗︎ object
IndexingResponse🔗︎
If indexing was requested in the ParseOptions.IndexingOptions the status of the index transaction will be output here.
IndexingResponse properties
Code 🔗︎ string
Code🔗︎
| Code | Description |
|---|---|
Success |
Successful transaction |
MissingParameter |
A required parameter wasn't provided |
InvalidParameter |
A parameter was incorrectly specified |
AuthenticationError |
An error occurred with the credentials provided |
DataNotFound |
Data with the specified name wasn't found |
ConstraintError |
Data in the request is not allowed with the specific action being requested. |
ProfessionNormalizationResponse 🔗︎ object
ProfessionNormalizationResponse🔗︎
If profession normalization was requested in the ProfessionsSettings.Normalize the status of the profession normalization transaction will be output here.
ProfessionNormalizationResponse properties
FlexResponse 🔗︎ object
FlexResponse🔗︎
Information about the FlexRequests transaction, if any were provided.
FlexResponse properties
Code 🔗︎ string
Code🔗︎
| Code | Description |
|---|---|
Success |
Successful transaction |
MissingParameter |
A required parameter wasn't provided |
InvalidParameter |
A parameter was incorrectly specified |
ResumeData 🔗︎ object
ResumeData🔗︎
The main output from the Textkernel CV/Resume Parser.
ResumeData properties
ContactInformation 🔗︎ object
ContactInformation🔗︎
The candidate's contact information found on the resume.
ContactInformation properties
CandidateName 🔗︎ object
CandidateName🔗︎
The candidate's name.
CandidateName properties
Prefix 🔗︎ string
Prefix🔗︎
This field is not available for all languages. See low-usage fields for more information.
A prefix for a name, such as Dr.
Moniker 🔗︎ string
Moniker🔗︎
This field is not available for all languages. See low-usage fields for more information.
The preferred given (first) name or nickname. This is rarely populated.
Suffix 🔗︎ string
Suffix🔗︎
This field is not available for all languages. See low-usage fields for more information.
A suffix for a name, such as Jr. or III.
Telephones 🔗︎ object[]
Telephones🔗︎
The candidate's phone numbers. If multiple numbers are found, mobile phone numbers will be listed first.
Telephones properties
Location 🔗︎ object
Location🔗︎
The candidate's location/address. The Parser does not standardize addresses. Address standardization services are available, including for example the Google Maps API, that can take the Parser's contact info fields and standardize/geocode the data.
Location properties
PersonalAttributes 🔗︎ object
PersonalAttributes🔗︎
Personal information provided by the candidate on the resume.
PersonalAttributes properties
Availability 🔗︎ string
Availability🔗︎
This field is not available for all languages. See low-usage fields for more information.
The availability of the candidate.
Birthplace 🔗︎ string
Birthplace🔗︎
This field is not available for all languages. See low-usage fields for more information.
The birthplace of the candidate.
CurrentSalary 🔗︎ object
CurrentSalary🔗︎
This field is not available for all languages. See low-usage fields for more information.
The current salary listed on the resume.
CurrentSalary properties
DateOfBirth 🔗︎ object
DateOfBirth🔗︎
The date of birth given on the resume
DateOfBirth properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
FamilyComposition 🔗︎ string
FamilyComposition🔗︎
This field is not available for all languages. See low-usage fields for more information.
The family composition.
FathersName 🔗︎ string
FathersName🔗︎
This field is not available for all languages. See low-usage fields for more information.
The candidate's father's name listed on the resume.
HukouCity 🔗︎ string
HukouCity🔗︎
This field is not available for all languages. See low-usage fields for more information.
Used in Chinese resumes.
HukouArea 🔗︎ string
HukouArea🔗︎
This field is not available for all languages. See low-usage fields for more information.
Used in Chinese resumes.
MaritalStatus 🔗︎ string
MaritalStatus🔗︎
This field is not available for all languages. See low-usage fields for more information.
The marital status listed on the resume.
MothersMaidenName 🔗︎ string
MothersMaidenName🔗︎
This field is not available for all languages. See low-usage fields for more information.
The candidate's mother's maiden name listed on the resume.
MotherTongue 🔗︎ string
MotherTongue🔗︎
The candidate's mother tongue (native language) listed on the resume.
NationalIdentities 🔗︎ object[]
NationalIdentities🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any national identities provided on the resume.
NationalIdentities properties
PassportNumber 🔗︎ string
PassportNumber🔗︎
This field is not available for all languages. See low-usage fields for more information.
The candidate's passport number listed on the resume.
PreferredLocation 🔗︎ string
PreferredLocation🔗︎
This field is not available for all languages. See low-usage fields for more information.
The candidate's preferred location listed on the resume.
RequiredSalary 🔗︎ object
RequiredSalary🔗︎
This field is not available for all languages. See low-usage fields for more information.
The candidate's required salary listed on the resume.
RequiredSalary properties
VisaStatus 🔗︎ string
VisaStatus🔗︎
This field is not available for all languages. See low-usage fields for more information.
The candidate's visa status listed on the resume.
WillingToRelocate 🔗︎ string
WillingToRelocate🔗︎
This field is not available for all languages. See low-usage fields for more information.
Whether the candidate is willing to relocate.
Education 🔗︎ object
Education🔗︎
The candidate's education history found on the resume.
Education properties
HighestDegree 🔗︎ object
HighestDegree🔗︎
The highest degree obtained by a candidate
HighestDegree properties
NormalizedLocal 🔗︎ object
NormalizedLocal🔗︎
The normalized code/description of the degree based on the CV locale.
NormalizedLocal properties
EducationDetails 🔗︎ object[]
EducationDetails🔗︎
All of the education details listed on a resume
EducationDetails properties
SchoolType 🔗︎ string
SchoolType🔗︎
The type of the school attended. One of:
- UNSPECIFIED
- lowerSchool
- highschool
- secondary
- trade
- professional
- vocational
- community
- college
- university
Location 🔗︎ object
Location🔗︎
The Country/Region/City of the school, if found
Location properties
Degree 🔗︎ object
Degree🔗︎
The degree obtained (or worked toward)
Degree properties
NormalizedLocal 🔗︎ object
NormalizedLocal🔗︎
The normalized code/description of the degree based on the CV locale.
NormalizedLocal properties
NormalizedInternational 🔗︎ object
NormalizedInternational🔗︎
The normalized code/description of the degree based on an international standard.
NormalizedInternational properties
Type 🔗︎ string Deprecated
Type🔗︎
Deprecated - use NormalizedLocal or NormalizedInternational instead.
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
GPA 🔗︎ object
GPA🔗︎
The GPA/marks listed on the resume
GPA properties
NormalizedScore 🔗︎ decimal
NormalizedScore🔗︎
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
LastEducationDate 🔗︎ object Deprecated
LastEducationDate🔗︎
Deprecated - use EndDate instead.
LastEducationDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
StartDate 🔗︎ object
StartDate🔗︎
The date education started
StartDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
EmploymentHistory 🔗︎ object
EmploymentHistory🔗︎
The candidate's employment/work history found on the resume.
EmploymentHistory properties
ExperienceSummary 🔗︎ string
ExperienceSummary🔗︎
A summary of all the work history with important calculated metadata
ExperienceSummary properties
Description 🔗︎ string
Description🔗︎
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.
This summary can be further enhanced by enabling SkillsSettings.Normalize on the request.
MonthsOfWorkExperience 🔗︎ integer
MonthsOfWorkExperience🔗︎
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.
MonthsOfManagementExperience 🔗︎ integer
MonthsOfManagementExperience🔗︎
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.
ExecutiveType 🔗︎ string
ExecutiveType🔗︎
Job titles are examined to determine the best category for any executive experience. If the candidate posesses no executive experience, "NONE" will be output. Possible values are One of:
- NONE
- ADMIN
- ACCOUNTING
- BUSINESS_DEV
- EXECUTIVE
- FINANCIAL
- GENERAL
- IT
- LEARNING
- MARKETING
- OPERATIONS
AverageMonthsPerEmployer 🔗︎ integer
AverageMonthsPerEmployer🔗︎
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.
FulltimeDirectHirePredictiveIndex 🔗︎ integer
FulltimeDirectHirePredictiveIndex🔗︎
This field is not available for all languages. See low-usage fields for more information.
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.
ManagementStory 🔗︎ string
ManagementStory🔗︎
A paragraph of text that summarizes the candidate's management experience (in English).
CurrentManagementLevel 🔗︎ string
CurrentManagementLevel🔗︎
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
ManagementScore 🔗︎ integer
ManagementScore🔗︎
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
AttentionNeeded 🔗︎ string
AttentionNeeded🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any abnormal findings about the candidate's career will be reported here. For example, if the candidate held a management-level position in a previous job, but not their current job.
Positions 🔗︎ object[]
Positions🔗︎
A list of jobs/positions found on the resume.
Positions properties
Employer 🔗︎ object
Employer🔗︎
The employer/company for this position. Will be null if IsSelfEmployed is null.
Employer properties
Name 🔗︎ object
Name🔗︎
The name of the employer (and an accuracy probability).
Name properties
Probability 🔗︎ string
Probability🔗︎
This field is not available for all languages. See low-usage fields for more information.
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
OtherFoundName 🔗︎ object
OtherFoundName🔗︎
Sometimes a second possible company name is found, or a department/organization within a company. This is that value, if it is found.
OtherFoundName properties
RelatedToByDates 🔗︎ string[]
RelatedToByDates🔗︎
A list of other positions Ids that have overlapping dates with this Position.
RelatedToByCompanyName 🔗︎ string[]
RelatedToByCompanyName🔗︎
A list of other positions Ids that have the same Employer as this Position.
IsSelfEmployed 🔗︎ bool
IsSelfEmployed🔗︎
This field is not available for all languages. See low-usage fields for more information.
True if the candidate was self-employed at this job/position.
JobTitle 🔗︎ object
JobTitle🔗︎
The job title for this position/job.
JobTitle properties
Normalized 🔗︎ string Deprecated
Normalized🔗︎
Deprecated - Use Profession Normalization (ProfessionsSettings.Normalize) instead. This value was a very basic normalization that simply removed special characters, etc. Profession Normalization is much more advanced and is taxonomy-based.
Probability 🔗︎ string
Probability🔗︎
This field is not available for all languages. See low-usage fields for more information.
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
StartDate 🔗︎ object
StartDate🔗︎
The start date listed for this position.
StartDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
EndDate 🔗︎ object
EndDate🔗︎
The end date listed for this position
EndDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
NumberEmployeesSupervised 🔗︎ object
NumberEmployeesSupervised🔗︎
This field is not available for all languages. See low-usage fields for more information.
How many employees were supervised in this position/job, or null.
NumberEmployeesSupervised properties
JobType 🔗︎ string
JobType🔗︎
This field is not available for all languages. See low-usage fields for more information.
The type of job. One of:
- directHire
- contract
- temp
- volunteer
- internship
- UNSPECIFIED
TaxonomyName 🔗︎ string Deprecated
TaxonomyName🔗︎
Deprecated - Use Profession Normalization (ProfessionsSettings.Normalize) instead.
The name of the skills taxonomy that this position was categorized as based on skills found in the job description. This field will not be output when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2.
SubTaxonomyName 🔗︎ string Deprecated
SubTaxonomyName🔗︎
Deprecated - Use Profession Normalization (ProfessionsSettings.Normalize) instead.
The name of the skills subtaxonomy that this position was categorized as based on skills found in the job description. This field will not be output when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2.
JobLevel 🔗︎ string
JobLevel🔗︎
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)
TaxonomyPercentage 🔗︎ integer Deprecated
TaxonomyPercentage🔗︎
Deprecated - Use Profession Normalization (ProfessionsSettings.Normalize) instead.
The percentage of this job described by the TaxonomyName. This value will always be 0 when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2.
NormalizedProfession 🔗︎ object
NormalizedProfession🔗︎
If ProfessionsSettings.Normalize was set to true, this will be populated for the most recent 3 positions.
NormalizedProfession properties
Profession 🔗︎ object
Profession🔗︎
Object containing the details of the profession concept.
Profession properties
Group 🔗︎ object
Group🔗︎
The object of the group to which the profession concept belongs.
Group properties
Class 🔗︎ object
Class🔗︎
The object of the class to which the profession concept belongs.
Class properties
Skills 🔗︎ object
Skills🔗︎
Skills output when version 2 of the taxonomy is utilized.
Skills properties
Raw 🔗︎ object[]
Raw🔗︎
Array of skills exactly as found in the plain text of the document.
Raw properties
FoundIn 🔗︎ object[]
FoundIn🔗︎
Array of objects denoting where in the document this skill was located.
FoundIn properties
Normalized 🔗︎ object
Normalized🔗︎
Normalized skills output when version 2 of the taxonomy is utilized and SkillsSettings.Normalize is set to true.
Normalized properties
FoundIn 🔗︎ object[]
FoundIn🔗︎
Array of objects denoting where in the document this skill was located
FoundIn properties
MonthsExperience 🔗︎ object
MonthsExperience🔗︎
Describes the amount of experience a candidate has with this skill. Null if unknown.
MonthsExperience properties
RelatedProfessionClasses 🔗︎ object
RelatedProfessionClasses🔗︎
Professions most related to the document. Only output if version 2 of the skills taxonomy is utilized and SkillsSettings.Normalize is set to true.
RelatedProfessionClasses properties
SkillsData 🔗︎ object[] Deprecated
SkillsData🔗︎
Deprecated. Use v2 skills taxonomy and its associated Skills output.
Certifications 🔗︎ object[]
Certifications🔗︎
This field is not available for all languages. See low-usage fields for more information.
Certifications found on a resume.
Certifications properties
MatchedFromList 🔗︎ bool
MatchedFromList🔗︎
True if Textkernel found this by matching from a known list of certifications. False if Textkernel found this by analyzing the context and determining it was a certification.
IsVariation 🔗︎ bool
IsVariation🔗︎
Textkernel generates several possible variations for some certifications to be used in Search & Match. This greatly improves Matching, since different candidates have different ways of listing a certification. If this certification is a Textkernel-created variation of a certification found on the resume, this property will be true.
Licenses 🔗︎ object[]
Licenses🔗︎
This field is not available for all languages. See low-usage fields for more information.
Licenses found on a resume. These are professional licenses, not driving licenses. For driving licenses, see PersonalAttributes.
Licenses properties
Associations 🔗︎ object[]
Associations🔗︎
This field is not available for all languages. See low-usage fields for more information.
Associations/organizations found on a resume.
Associations properties
LanguageCompetencies 🔗︎ object[]
LanguageCompetencies🔗︎
Any language competencies (fluent in, can read, can write, etc) found on the resume.
LanguageCompetencies properties
MilitaryExperience 🔗︎ object[]
MilitaryExperience🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any military experience listed on the resume.
MilitaryExperience properties
StartDate 🔗︎ object
StartDate🔗︎
The start date for this military post/job.
StartDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
EndDate 🔗︎ object
EndDate🔗︎
The end date for this military post/job.
EndDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
SecurityCredentials 🔗︎ object[]
SecurityCredentials🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any security credentials/clearances listed on the resume.
SecurityCredentials properties
References 🔗︎ object[]
References🔗︎
This field is not available for all languages. See low-usage fields for more information.
References listed on a resume.
References properties
Location 🔗︎ object
Location🔗︎
The physical location of the reference.
Location properties
Achievements 🔗︎ string[]
Achievements🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any achievements listed on the resume.
Training 🔗︎ object
Training🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any training listed on the resume.
Training properties
Trainings 🔗︎ object[]
Trainings🔗︎
Information about each training history we found.
Trainings properties
Qualifications 🔗︎ string[]
Qualifications🔗︎
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.
StartDate 🔗︎ object
StartDate🔗︎
The date the training started.
StartDate properties
Date 🔗︎ date
Date🔗︎
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
Patents 🔗︎ string
Patents🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any patents listed on the resume.
Publications 🔗︎ string
Publications🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any publications listed on the resume.
SpeakingEngagements 🔗︎ string
SpeakingEngagements🔗︎
This field is not available for all languages. See low-usage fields for more information.
Any speaking engagements/appearances listed on the resume.
ResumeMetadata 🔗︎ object
ResumeMetadata🔗︎
Metadata about the parsed resume.
ResumeMetadata properties
DocumentLanguage 🔗︎ string
DocumentLanguage🔗︎
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.
DocumentCulture 🔗︎ string
DocumentCulture🔗︎
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.
DocumentLastModified 🔗︎ date
DocumentLastModified🔗︎
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.
FoundSections 🔗︎ object[]
FoundSections🔗︎
This field is not available for all languages. See low-usage fields for more information.
A list of sections found in the resume
FoundSections properties
SectionType 🔗︎ string
SectionType🔗︎
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
ResumeQuality 🔗︎ object[]
ResumeQuality🔗︎
This field is not available for all languages. See low-usage fields for more information.
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 theResume Quality Documentation
ResumeQuality properties
Level 🔗︎ string
Level🔗︎
The level/severity of this assessment. One of:
- Suggested Improvements
- Data Missing
- Major Issues Found
- Fatal Problems Found
Findings 🔗︎ object[]
Findings🔗︎
A list of findings of the same severity/level.
Findings properties
QualityCode 🔗︎ string
QualityCode🔗︎
A unique 3-digit code to identify what type of issue was found. See all possibilities here.
RedactedResumeData 🔗︎ object
RedactedResumeData🔗︎
This property is the Value.ResumeData with all of the Personally Identifiable Information (PII) fields such as first name, last name, email addresses, phone numbers, etc. redacted.
ConversionMetadata 🔗︎ object
ConversionMetadata🔗︎
Information about converting the document to plain text
ConversionMetadata properties
SuggestedFileExtension 🔗︎ string
SuggestedFileExtension🔗︎
The suggested extension based on the DetectedType.
OutputValidityCode 🔗︎ string
OutputValidityCode🔗︎
The computed validity based on the source text. This will indicate whether a document looks like a legitimate resume or not. See here for more details.
Conversions 🔗︎ object
Conversions🔗︎
Any additional conversions you requested will be here (eg: PDF or HTML).
Conversions properties
PDF 🔗︎ string
PDF🔗︎
If requested by ParseOptions.OutputPdf, this is the document converted to a PDF. This is a byte[] as a Base64-encoded string.
HTML 🔗︎ string
HTML🔗︎
If requested by ParseOptions.OutputHTML, this is the document converted to HTML.
ParsingMetadata 🔗︎ object
ParsingMetadata🔗︎
Information about the parsing transaction.
ParsingMetadata properties
ElapsedMilliseconds 🔗︎ string
ElapsedMilliseconds🔗︎
How long it took to parse the document, in milliseconds.
Sample JSON
{
"Info": {
"Code": "string",
"Message": "string",
"TransactionId": "string",
"EngineVersion": "string",
"ApiVersion": "string",
"TotalElapsedMilliseconds": 0,
"TransactionCost": 0,
"CustomerDetails": {
"AccountId": "string",
"Name": "string",
"IPAddress": "string",
"Region": "string",
"CreditsRemaining": 0,
"CreditsUsed": 0,
"ExpirationDate": "2021-12-31",
"MaximumConcurrentRequests": 0
}
},
"Value": {
"ParsingResponse": {
"Code": "Success",
"Message": "string"
},
"GeocodeResponse": {
"Code": "Success",
"Message": "string"
},
"IndexingResponse": {
"Code": "Success",
"Message": "string"
},
"ProfessionNormalizationResponse": {
"Code": "Success",
"Message": "string"
},
"FlexResponse": {
"Code": "Success",
"Message": "string",
"Responses": [
{
"Identifier": "string",
"Reply": "string",
"ReplyList": [
"string"
]
}
]
},
"ResumeData": {
"ContactInformation": {
"CandidateName": {
"FormattedName": "string",
"Prefix": "string",
"GivenName": "string",
"Moniker": "string",
"MiddleName": "string",
"FamilyName": "string",
"Suffix": "string"
},
"Telephones": [
{
"Raw": "string",
"Normalized": "string",
"InternationalCountryCode": "string",
"AreaCityCode": "string",
"SubscriberNumber": "string"
}
],
"EmailAddresses": [
"string"
],
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
},
"WebAddresses": [
{
"Address": "string",
"Type": "string"
}
]
},
"ProfessionalSummary": "string",
"Objective": "string",
"CoverLetter": "string",
"PersonalAttributes": {
"Availability": "string",
"Birthplace": "string",
"CurrentLocation": "string",
"CurrentSalary": {
"Currency": "string",
"Amount": 0
},
"DateOfBirth": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"DrivingLicense": "string",
"FamilyComposition": "string",
"FathersName": "string",
"Gender": "string",
"HukouCity": "string",
"HukouArea": "string",
"MaritalStatus": "string",
"MothersMaidenName": "string",
"MotherTongue": "string",
"NationalIdentities": [
{
"Number": "string",
"Phrase": "string"
}
],
"Nationality": "string",
"PassportNumber": "string",
"PreferredLocation": "string",
"RequiredSalary": {
"Currency": "string",
"Amount": 0
},
"VisaStatus": "string",
"WillingToRelocate": "string"
},
"Education": {
"HighestDegree": {
"Name": {
"Raw": "string",
"Normalized": "string"
},
"NormalizedLocal": {
"Code": "string",
"Description": "string"
},
"NormalizedInternational": {
"Code": "string",
"Description": "string"
},
"Type": "string"
},
"EducationDetails": [
{
"Id": "string",
"Text": "string",
"SchoolName": {
"Raw": "string",
"Normalized": "string"
},
"SchoolType": "string",
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
},
"Degree": {
"Name": {
"Raw": "string",
"Normalized": "string"
},
"NormalizedLocal": {
"Code": "string",
"Description": "string"
},
"NormalizedInternational": {
"Code": "string",
"Description": "string"
},
"Type": "string"
},
"Majors": [
"string"
],
"Minors": [
"string"
],
"GPA": {
"Score": "string",
"ScoringSystem": "string",
"MaxScore": "string",
"MinimumScore": "string",
"NormalizedScore": 0
},
"LastEducationDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"HasValue": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"HasValue": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"Graduated": {
"Value": true
}
}
]
},
"EmploymentHistory": {
"ExperienceSummary": {
"Description": "string",
"MonthsOfWorkExperience": 0,
"MonthsOfManagementExperience": 0,
"ExecutiveType": "string",
"AverageMonthsPerEmployer": 0,
"FulltimeDirectHirePredictiveIndex": 0,
"ManagementStory": "string",
"CurrentManagementLevel": "string",
"ManagementScore": 0,
"AttentionNeeded": "string"
},
"Positions": [
{
"Id": "string",
"Employer": {
"Name": {
"Probability": "string",
"Raw": "string",
"Normalized": "string"
},
"OtherFoundName": {
"Raw": "string",
"Normalized": "string"
},
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
}
},
"RelatedToByDates": [
"string"
],
"RelatedToByCompanyName": [
"string"
],
"IsSelfEmployed": true,
"IsCurrent": true,
"JobTitle": {
"Raw": "string",
"Normalized": "string",
"Probability": "string",
"Variations": [
"string"
]
},
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"NumberEmployeesSupervised": {
"Value": 0
},
"JobType": "string",
"TaxonomyName": "string",
"SubTaxonomyName": "string",
"JobLevel": "string",
"TaxonomyPercentage": "string",
"Description": "string",
"Bullets": [
{
"Type": "string",
"Text": "string"
}
],
"NormalizedProfession": {
"Profession": {
"CodeId": 0,
"Description": ""
},
"Group": {
"CodeId": 0,
"Description": ""
},
"Class": {
"CodeId": 0,
"Description": ""
},
"ISCO": {
"Version": "",
"CodeId": 0,
"Description": ""
},
"ONET": {
"Version": "",
"CodeId": "",
"Description": ""
},
"Confidence": 0.0
}
}
]
},
"Skills": {
"Raw": [
{
"Name": "",
"FoundIn": [
{
"SectionType": "",
"Id": ""
}
],
"MonthsExperience": {
"Value": 0
},
"LastUsed": {
"Value": ""
}
}
],
"Normalized": [
{
"FoundIn": [
{
"SectionType": "",
"Id": ""
}
],
"MonthsExperience": {
"Value": 0
},
"LastUsed": {
"Value": ""
},
"Name": "",
"Type": "",
"Id": "",
"RawSkills": [
""
]
}
],
"RelatedProfessionClasses": [
{
"Name": "",
"Id": "",
"Percent": 0,
"Groups": [
{
"Name": "",
"Id": "",
"Percent": 0,
"NormalizedSkills": [
""
]
}
]
}
]
},
"SkillsData": [
{
"Root": "string",
"Taxonomies": [
{
"Id": "string",
"Name": "string",
"PercentOfOverall": 0,
"SubTaxonomies": [
{
"PercentOfOverall": 0,
"PercentOfParent": 0,
"SubTaxonomyId": "string",
"SubTaxonomyName": "string",
"Skills": [
{
"Id": "string",
"Name": "string",
"FoundIn": {
"SectionType": "string",
"Id": "string"
},
"ExistsInText": true,
"Variations": [
{
"MonthsExperience": {
"Value": 0
},
"LastUsed": {
"Value": "2020-11-02"
},
"Id": "string",
"Name": "string",
"FoundIn": {
"SectionType": "string",
"Id": "string"
},
"ExistsInText": true
}
],
"MonthsExperience": {
"Value": 0
},
"LastUsed": {
"Value": "2020-11-02"
},
"ChildrenMonthsExperience": {
"Value": 0
},
"ChildrenLastUsed": {
"Value": "2020-11-02"
}
}
]
}
]
}
]
}
],
"Certifications": [
{
"Name": "string",
"MatchedFromList": true,
"IsVariation": true
}
],
"Licenses": [
{
"Name": "string",
"MatchedFromList": true
}
],
"Associations": [
{
"Organization": "string",
"Role": "string",
"FoundInContext": "string"
}
],
"LanguageCompetencies": [
{
"Language": "string",
"LanguageCode": "string",
"FoundInContext": "string"
}
],
"MilitaryExperience": [
{
"Country": "string",
"Service": {
"Name": "string",
"Branch": "string",
"Rank": "string"
},
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"FoundInContext": "string"
}
],
"SecurityCredentials": [
{
"Name": "string",
"FoundInContext": "string"
}
],
"References": [
{
"ReferenceName": {
"FormattedName": "string",
"Prefix": "string",
"GivenName": "string",
"Moniker": "string",
"MiddleName": "string",
"FamilyName": "string",
"Suffix": "string"
},
"Title": "string",
"Company": "string",
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
},
"Telephones": [
{
"Raw": "string",
"Normalized": "string"
}
],
"EmailAddresses": [
"string"
],
"WebAddresses": [
{
"Address": "string",
"Type": "string"
}
]
}
],
"Achievements": [
"string"
],
"Training": {
"Text": "string",
"Trainings": [
{
"Text": "string",
"Entity": "string",
"Qualifications": [
"string"
],
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
}
}
]
},
"Hobbies": "string",
"Patents": "string",
"Publications": "string",
"SpeakingEngagements": "string",
"ResumeMetadata": {
"FoundSections": [
{
"FirstLineNumber": 0,
"LastLineNumber": 0,
"SectionType": "string",
"HeaderTextFound": "string"
}
],
"ResumeQuality": [
{
"Level": "string",
"Findings": [
{
"QualityCode": "string",
"SectionIdentifiers": [
{
"SectionType": "string",
"Id": "string"
}
],
"Message": "string"
}
]
}
],
"ReservedData": {
"Phones": [
"string"
],
"Names": [
"string"
],
"EmailAddresses": [
"string"
],
"Urls": [
"string"
],
"OtherData": [
"string"
]
},
"PlainText": "string",
"DocumentLanguage": "string",
"DocumentCulture": "string",
"ParserSettings": "string",
"DocumentLastModified": "2020-11-02"
},
"UserDefinedTags": [
"string"
]
},
"RedactedResumeData": {
"ContactInformation": {
"CandidateName": {
"FormattedName": "string",
"Prefix": "string",
"GivenName": "string",
"Moniker": "string",
"MiddleName": "string",
"FamilyName": "string",
"Suffix": "string"
},
"Telephones": [
{
"Raw": "string",
"Normalized": "string",
"InternationalCountryCode": "string",
"AreaCityCode": "string",
"SubscriberNumber": "string"
}
],
"EmailAddresses": [
"string"
],
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
},
"WebAddresses": [
{
"Address": "string",
"Type": "string"
}
]
},
"ProfessionalSummary": "string",
"Objective": "string",
"CoverLetter": "string",
"PersonalAttributes": {
"Availability": "string",
"Birthplace": "string",
"CurrentLocation": "string",
"CurrentSalary": {
"Currency": "string",
"Amount": 0
},
"DateOfBirth": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"DrivingLicense": "string",
"FamilyComposition": "string",
"FathersName": "string",
"Gender": "string",
"HukouCity": "string",
"HukouArea": "string",
"MaritalStatus": "string",
"MothersMaidenName": "string",
"MotherTongue": "string",
"NationalIdentities": [
{
"Number": "string",
"Phrase": "string"
}
],
"Nationality": "string",
"PassportNumber": "string",
"PreferredLocation": "string",
"RequiredSalary": {
"Currency": "string",
"Amount": 0
},
"VisaStatus": "string",
"WillingToRelocate": "string"
},
"Education": {
"HighestDegree": {
"Name": {
"Raw": "string",
"Normalized": "string"
},
"NormalizedLocal": {
"Code": "string",
"Description": "string"
},
"NormalizedInternational": {
"Code": "string",
"Description": "string"
},
"Type": "string"
},
"EducationDetails": [
{
"Id": "string",
"Text": "string",
"SchoolName": {
"Raw": "string",
"Normalized": "string"
},
"SchoolType": "string",
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
},
"Degree": {
"Name": {
"Raw": "string",
"Normalized": "string"
},
"NormalizedLocal": {
"Code": "string",
"Description": "string"
},
"NormalizedInternational": {
"Code": "string",
"Description": "string"
},
"Type": "string"
},
"Majors": [
"string"
],
"Minors": [
"string"
],
"GPA": {
"Score": "string",
"ScoringSystem": "string",
"MaxScore": "string",
"MinimumScore": "string",
"NormalizedScore": 0
},
"LastEducationDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"HasValue": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"HasValue": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"Graduated": {
"Value": true
}
}
]
},
"EmploymentHistory": {
"ExperienceSummary": {
"Description": "string",
"MonthsOfWorkExperience": 0,
"MonthsOfManagementExperience": 0,
"ExecutiveType": "string",
"AverageMonthsPerEmployer": 0,
"FulltimeDirectHirePredictiveIndex": 0,
"ManagementStory": "string",
"CurrentManagementLevel": "string",
"ManagementScore": 0,
"AttentionNeeded": "string"
},
"Positions": [
{
"Id": "string",
"Employer": {
"Name": {
"Probability": "string",
"Raw": "string",
"Normalized": "string"
},
"OtherFoundName": {
"Raw": "string",
"Normalized": "string"
},
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
}
},
"RelatedToByDates": [
"string"
],
"RelatedToByCompanyName": [
"string"
],
"IsSelfEmployed": true,
"IsCurrent": true,
"JobTitle": {
"Raw": "string",
"Normalized": "string",
"Probability": "string",
"Variations": [
"string"
]
},
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"NumberEmployeesSupervised": {
"Value": 0
},
"JobType": "string",
"TaxonomyName": "string",
"SubTaxonomyName": "string",
"JobLevel": "string",
"Description": "string",
"Bullets": [
{
"Type": "string",
"Text": "string"
}
]
}
]
},
"SkillsData": [
{
"Root": "string",
"Taxonomies": [
{
"Id": "string",
"Name": "string",
"PercentOfOverall": 0,
"SubTaxonomies": [
{
"PercentOfOverall": 0,
"PercentOfParent": 0,
"SubTaxonomyId": "string",
"SubTaxonomyName": "string",
"Skills": [
{
"Id": "string",
"Name": "string",
"FoundIn": {
"SectionType": "string",
"Id": "string"
},
"ExistsInText": true,
"Variations": [
{
"MonthsExperience": {
"Value": 0
},
"LastUsed": {
"Value": "2020-11-02"
},
"Id": "string",
"Name": "string",
"FoundIn": {
"SectionType": "string",
"Id": "string"
},
"ExistsInText": true
}
],
"MonthsExperience": {
"Value": 0
},
"LastUsed": {
"Value": "2020-11-02"
},
"ChildrenMonthsExperience": {
"Value": 0
},
"ChildrenLastUsed": {
"Value": "2020-11-02"
}
}
]
}
]
}
]
}
],
"Certifications": [
{
"Name": "string",
"MatchedFromList": true,
"IsVariation": true
}
],
"Licenses": [
{
"Name": "string",
"MatchedFromList": true
}
],
"Associations": [
{
"Organization": "string",
"Role": "string",
"FoundInContext": "string"
}
],
"LanguageCompetencies": [
{
"Language": "string",
"LanguageCode": "string",
"FoundInContext": "string"
}
],
"MilitaryExperience": [
{
"Country": "string",
"Service": {
"Name": "string",
"Branch": "string",
"Rank": "string"
},
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"FoundInContext": "string"
}
],
"SecurityCredentials": [
{
"Name": "string",
"FoundInContext": "string"
}
],
"References": [
{
"ReferenceName": {
"FormattedName": "string",
"Prefix": "string",
"GivenName": "string",
"Moniker": "string",
"MiddleName": "string",
"FamilyName": "string",
"Suffix": "string"
},
"Title": "string",
"Company": "string",
"Location": {
"CountryCode": "string",
"PostalCode": "string",
"Regions": [
"string"
],
"Municipality": "string",
"StreetAddressLines": [
"string"
],
"GeoCoordinates": {
"Latitude": 0,
"Longitude": 0,
"Source": "string"
}
},
"Telephones": [
{
"Raw": "string",
"Normalized": "string"
}
],
"EmailAddresses": [
"string"
],
"WebAddresses": [
{
"Address": "string",
"Type": "string"
}
]
}
],
"Achievements": [
"string"
],
"Training": {
"Text": "string",
"Trainings": [
{
"Text": "string",
"Entity": "string",
"Qualifications": [
"string"
],
"StartDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
},
"EndDate": {
"Date": "2020-11-02",
"IsCurrentDate": true,
"FoundYear": true,
"FoundMonth": true,
"FoundDay": true
}
}
]
},
"Hobbies": "string",
"Patents": "string",
"Publications": "string",
"SpeakingEngagements": "string",
"ResumeMetadata": {
"FoundSections": [
{
"FirstLineNumber": 0,
"LastLineNumber": 0,
"SectionType": "string",
"HeaderTextFound": "string"
}
],
"ResumeQuality": [
{
"Level": "string",
"Findings": [
{
"QualityCode": "string",
"SectionIdentifiers": [
{
"SectionType": "string",
"Id": "string"
}
],
"Message": "string"
}
]
}
],
"ReservedData": {
"Phones": [
"string"
],
"Names": [
"string"
],
"EmailAddresses": [
"string"
],
"Urls": [
"string"
],
"OtherData": [
"string"
]
},
"PlainText": "string",
"DocumentLanguage": "string",
"DocumentCulture": "string",
"ParserSettings": "string",
"DocumentLastModified": "2020-11-02"
},
"UserDefinedTags": [
"string"
]
},
"ConversionMetadata": {
"DetectedType": "string",
"SuggestedFileExtension": "string",
"OutputValidityCode": "string",
"ElapsedMilliseconds": 0,
"DocumentHash": "string"
},
"Conversions": {
"PDF": "string",
"HTML": "string",
"RTF": "string",
"CandidateImage": "string",
"CandidateImageExtension": "string"
},
"ParsingMetadata": {
"ElapsedMilliseconds": 0,
"TimedOut": true,
"TimedOutAtMilliseconds": {
"Value": 0
}
}
}
}