Skip to content
Tx Platform
Geocode Parsed Resume

Geocode a Parsed Resume🔗︎

HTTP Verb Path
POST /v10/geocoder/resume

Get or insert geocode coordinate values (latitude/longitude) for a parsed resume.

Info

Request Body🔗︎

ResumeData 🔗︎ object required

ResumeData🔗︎

Parsed ResumeData from the Textkernel CV/Resume Parser. See Parse a Resume

Provider 🔗︎ string

Provider🔗︎

The Provider you wish to use to geocode the postal address (current options are "Google" or "Bing"). If not specified, we will default to Google. If passing a ProviderKey, this field is required.

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.

PostalCode 🔗︎ string

PostalCode🔗︎

The postal code (or zip code) for the postal address.

Region 🔗︎ string

Region🔗︎

The region (i.e. State for U.S. addresses) for the postal address.

Municipality 🔗︎ string

Municipality🔗︎

The municipality (i.e. City for U.S. addresses) for the postal address

AddressLine 🔗︎ string

AddressLine🔗︎

The address line (i.e. Street address for U.S. address) for the postal address

Sample JSON
{
  "ResumeData": "...",
  "Provider": "",
  "ProviderKey": "",
  "PostalAddress": {
    "CountryCode": "",
    "PostalCode": "",
    "Region": "",
    "Municipality": "",
    "AddressLine": ""
  }
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.


Info 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
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
Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

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.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

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

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

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.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.


Value properties

ResumeData 🔗︎ object

ResumeData🔗︎

The main output from the Textkernel CV/Resume Parser containing the geocoded coordinates.


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

FormattedName 🔗︎ string

FormattedName🔗︎

The name in a standard format.

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.

GivenName 🔗︎ string

GivenName🔗︎

The given (first) name.

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.

MiddleName 🔗︎ string

MiddleName🔗︎

The middle name or initial.

FamilyName 🔗︎ string

FamilyName🔗︎

The family (last) name.

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

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

InternationalCountryCode 🔗︎ string

InternationalCountryCode🔗︎

The international country code part of the phone number.

AreaCityCode 🔗︎ string

AreaCityCode🔗︎

The area code part of the phone number.

SubscriberNumber 🔗︎ string

SubscriberNumber🔗︎

The subscriber number part of the phone number.

EmailAddresses 🔗︎ string[]

EmailAddresses🔗︎

The candidate's email addresses.

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

CountryCode 🔗︎ string

CountryCode🔗︎

The 2-letter ISO 3166 country code.

PostalCode 🔗︎ string

PostalCode🔗︎

The Postal or Zip code.

Regions 🔗︎ string[]

Regions🔗︎

The Regions/Districts/States.

Municipality 🔗︎ string

Municipality🔗︎

The City/Municipality/Town.

StreetAddressLines 🔗︎ string[]

StreetAddressLines🔗︎

Street address lines.

GeoCoordinates 🔗︎ object

GeoCoordinates🔗︎

If geocoding has been done, this is the lat/lon for the location.


GeoCoordinates properties

Latitude 🔗︎ decimal

Latitude🔗︎

The latitude, in degrees.

Longitude 🔗︎ decimal

Longitude🔗︎

The longitude, in degrees.

Source 🔗︎ string

Source🔗︎

The geocoding source, such as Google or Bing.

WebAddresses 🔗︎ object[]

WebAddresses🔗︎

The candidate's web addresses (URLs, social media) listed on the resume.


WebAddresses properties

Address 🔗︎ string

Address🔗︎

The URL or username

Type 🔗︎ string

Type🔗︎

The type of address. One of:

  • PersonalWebsite
  • LinkedIn
  • Twitter
  • GitHub
  • Facebook
  • Skype
  • WhatsApp
  • StackOverflow
  • Instagram
  • Reddit
  • Signal
  • Quora
  • ICQ
  • WeChat
  • QQ
  • Telegraph
  • Telegram
  • MeWe
  • Parler
  • Gab
  • Unknown
ProfessionalSummary 🔗︎ string

ProfessionalSummary🔗︎

The professional summary from the resume.

Objective 🔗︎ string

Objective🔗︎

The candidate's written objective.

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.

CurrentLocation 🔗︎ string

CurrentLocation🔗︎

The current location listed on the resume.

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

Currency 🔗︎ string

Currency🔗︎

The three-letter currency, eg: USD

Amount 🔗︎ decimal

Amount🔗︎

The amount of the salary (usually yearly when listed on a resume)

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

DrivingLicense 🔗︎ string

DrivingLicense🔗︎

A driving license listed on the resume.

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.

Gender 🔗︎ string

Gender🔗︎

The candidate's gender 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🔗︎

This field is not available for all languages. See low-usage fields for more information.

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

Number 🔗︎ string

Number🔗︎

The national identity number.

Phrase 🔗︎ string

Phrase🔗︎

The national identity number.

Nationality 🔗︎ string

Nationality🔗︎

The candidate's nationality listed on the resume.

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

Currency 🔗︎ string

Currency🔗︎

The three-letter currency, eg: USD

Amount 🔗︎ decimal

Amount🔗︎

The amount of the salary (usually yearly when listed on a resume)

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

Name 🔗︎ object

Name🔗︎

The name of the degree


Name properties

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

Type 🔗︎ string

Type🔗︎

The type of degree.

EducationDetails 🔗︎ object[]

EducationDetails🔗︎

All of the education details listed on a resume


EducationDetails properties

Id 🔗︎ string

Id🔗︎

The id of this education entry (one-based, so EDU-1 is the first, etc)

Text 🔗︎ string

Text🔗︎

The raw text from the resume.

SchoolName 🔗︎ object

SchoolName🔗︎

The name of the school attended


SchoolName properties

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

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

CountryCode 🔗︎ string

CountryCode🔗︎

The 2-letter ISO 3166 country code.

PostalCode 🔗︎ string

PostalCode🔗︎

The Postal or Zip code.

Regions 🔗︎ string[]

Regions🔗︎

The Regions/Districts/States.

Municipality 🔗︎ string

Municipality🔗︎

The City/Municipality/Town.

StreetAddressLines 🔗︎ string[]

StreetAddressLines🔗︎

Street address lines

GeoCoordinates 🔗︎ object

GeoCoordinates🔗︎

If geocoding has been done, this is the lat/lon for the location.


GeoCoordinates properties

Latitude 🔗︎ decimal

Latitude🔗︎

The latitude, in degrees.

Longitude 🔗︎ decimal

Longitude🔗︎

The longitude, in degrees.

Source 🔗︎ string

Source🔗︎

The geocoding source, such as Google or Bing.

Degree 🔗︎ object

Degree🔗︎

The degree obtained (or worked toward)


Degree properties

Name 🔗︎ object

Name🔗︎

The name of the degree


Name properties

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

Type 🔗︎ string

Type🔗︎

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
Majors 🔗︎ string[]

Majors🔗︎

Any majors/areas of major focus.

Minors 🔗︎ string[]

Minors🔗︎

Any minors/areas of minor focus.

GPA 🔗︎ object

GPA🔗︎

The GPA/marks listed on the resume


GPA properties

Score 🔗︎ string

Score🔗︎

The score found in the resume.

ScoringSystem 🔗︎ string

ScoringSystem🔗︎

The scoring system used on the resume.

MaxScore 🔗︎ string

MaxScore🔗︎

The max score in the scoring system.

MinimumScore 🔗︎ string

MinimumScore🔗︎

The minimum score in the scoring system.

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

EndDate 🔗︎ object

EndDate🔗︎

The date graduated or education ended


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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

Graduated 🔗︎ object

Graduated🔗︎

Whether or not the candidate graduated, or null if unknown.


Graduated properties

Value 🔗︎ bool

Value🔗︎

Whether or not the candidate graduated

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

Id 🔗︎ string

Id🔗︎

The id of this position (one-based, so POS-1 is the first, etc)

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

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

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

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

Location 🔗︎ object

Location🔗︎

The location/address of the employer.


Location properties

CountryCode 🔗︎ string

CountryCode🔗︎

The 2-letter ISO 3166 country code.

PostalCode 🔗︎ string

PostalCode🔗︎

The Postal or Zip code.

Regions 🔗︎ string[]

Regions🔗︎

The Regions/Districts/States.

Municipality 🔗︎ string

Municipality🔗︎

The City/Municipality/Town.

StreetAddressLines 🔗︎ string[]

StreetAddressLines🔗︎

Street address lines.

GeoCoordinates 🔗︎ object

GeoCoordinates🔗︎

If geocoding has been done, this is the lat/lon for the location.


GeoCoordinates properties

Latitude 🔗︎ decimal

Latitude🔗︎

The latitude, in degrees.

Longitude 🔗︎ decimal

Longitude🔗︎

The longitude, in degrees.

Source 🔗︎ string

Source🔗︎

The geocoding source, such as Google or Bing.

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.

IsCurrent 🔗︎ bool

IsCurrent🔗︎

True if the job/position is listed as current on the resume.

JobTitle 🔗︎ object

JobTitle🔗︎

The job title for this position/job.


JobTitle properties

Raw 🔗︎ string

Raw🔗︎

The raw text as it was found in the resume.

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

Variations 🔗︎ string[] Deprecated

Variations🔗︎

Deprecated - Use Profession Normalization (ProfessionsSettings.Normalize) instead. These variations are generated with a very basic algorithm. Profession Normalization is much more accurate/advanced and is taxonomy-based.

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

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

Value 🔗︎ integer

Value🔗︎

How many employees were supervised in this position/job.

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.

Description 🔗︎ string

Description🔗︎

The job description.

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

CodeId 🔗︎ int

CodeId🔗︎

The code id of the profession concept.

Description 🔗︎ string

Description🔗︎

The description of the profession concept.

Group 🔗︎ object

Group🔗︎

The object of the group to which the profession concept belongs.


Group properties

CodeId 🔗︎ int

CodeId🔗︎

The code id of the group to which the profession concept belongs.

Description 🔗︎ string

Description🔗︎

The description of the group to which the profession concept belongs.

Class 🔗︎ object

Class🔗︎

The object of the class to which the profession concept belongs.


Class properties

CodeId 🔗︎ int

CodeId🔗︎

The code id of the class to which the profession concept belongs.

Description 🔗︎ string

Description🔗︎

The description of the class to which the profession concept belongs.

ISCO 🔗︎ object

ISCO🔗︎

The object of the ISCO profession concept


ISCO properties

Version 🔗︎ string

Version🔗︎

The version of the ISCO taxonomy

CodeId 🔗︎ int

CodeId🔗︎

The code if of the ISCO profession concept

Description 🔗︎ string

Description🔗︎

The description of the ONET profession concept

ONET 🔗︎ object

ONET🔗︎

The object of the ONET profession concept


ONET properties

Version 🔗︎ string

Version🔗︎

The version of the ONET taxonomy

CodeId 🔗︎ string

CodeId🔗︎

The code id of the ONET profession concept

Description 🔗︎ string

Description🔗︎

The description of the ONET profession concept

Description 🔗︎ float

Description🔗︎

Overall confidence that the input job title was normalized to the correct profession concept

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

Name 🔗︎ string

Name🔗︎

The exact skill text extracted from the document.

FoundIn 🔗︎ object[]

FoundIn🔗︎

Array of objects denoting where in the document this skill was located.


FoundIn properties

SectionType 🔗︎ string

SectionType🔗︎

The section(s) where the skill was found.

Id 🔗︎ string

Id🔗︎

If applicable, the Position ID or Education Id.

MonthsExperience 🔗︎ object

MonthsExperience🔗︎

Describes the amount of experience a candidate has with this skill. Null if unknown.


MonthsExperience properties

Value 🔗︎ int

Value🔗︎

Describes the amount of experience a candidate has with this skill.

LastUsed 🔗︎ object

LastUsed🔗︎

Describes the date the candidate last used the skill (derived from position dates). Null if unknown.


LastUsed properties

Value 🔗︎ string

Value🔗︎

The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01

Normalized 🔗︎ object

Normalized🔗︎

Normalized skills output when version 2 of the taxonomy is utilized and SkillsSettings.Normalize is set to true.


Normalized properties

Name 🔗︎ string

Name🔗︎

Name of the normalized skill

FoundIn 🔗︎ object[]

FoundIn🔗︎

Array of objects denoting where in the document this skill was located


FoundIn properties

SectionType 🔗︎ string

SectionType🔗︎

The section(s) where the skill was found.

Id 🔗︎ string

Id🔗︎

If applicable, the Position ID or Education Id.

MonthsExperience 🔗︎ object

MonthsExperience🔗︎

Describes the amount of experience a candidate has with this skill. Null if unknown.


MonthsExperience properties

Value 🔗︎ int

Value🔗︎

Describes the amount of experience a candidate has with this skill.

LastUsed 🔗︎ object

LastUsed🔗︎

Describes the date the candidate last used the skill (derived from position dates). Null if unknown.


LastUsed properties

Value 🔗︎ string

Value🔗︎

The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01

Type 🔗︎ string

Type🔗︎

Type of skill. Possible values are Professional, IT, or Soft

Id 🔗︎ string

Id🔗︎

Id of this skill in the skills taxonomy

RawSkills 🔗︎ string[]

RawSkills🔗︎

Array of raw skills that were extracted that normalized to this skill.

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

Name 🔗︎ string

Name🔗︎

Name of the related profession

Id 🔗︎ string

Id🔗︎

Id of the related profession

Percent 🔗︎ int

Percent🔗︎

Percent of overall document that relates to this profession

Groups 🔗︎ object[]

Groups🔗︎

Array of objects representing groups of professions


Groups properties

Name 🔗︎ string

Name🔗︎

Name of the profession group

Id 🔗︎ string

Id🔗︎

Id of the profession group

Percent 🔗︎ int

Percent🔗︎

Percent of overall document described by this profession group. All groups across all classes will add up to 100%.

NormalizedSkills 🔗︎ string[]

NormalizedSkills🔗︎

Array of normalized skills associated to this profession group.

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

Name 🔗︎ string

Name🔗︎

The name of the certification.

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

Name 🔗︎ string

Name🔗︎

The name of the license.

MatchedFromList 🔗︎ bool

MatchedFromList🔗︎

True if Textkernel found this by matching from a known list of licensense. False if Textkernel found this by analyzing the context and determining it was a license.

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

Organization 🔗︎ string

Organization🔗︎

The name of the association/organization.

Role 🔗︎ string

Role🔗︎

The role the candidate held.

FoundInContext 🔗︎ string

FoundInContext🔗︎

The full text in which this association was found.

LanguageCompetencies 🔗︎ object[]

LanguageCompetencies🔗︎

Any language competencies (fluent in, can read, can write, etc) found on the resume.


LanguageCompetencies properties

Language 🔗︎ string

Language🔗︎

The language name.

LanguageCode 🔗︎ string

LanguageCode🔗︎

The two-letter ISO 639-1 code for the language.

FoundInContext 🔗︎ string

FoundInContext🔗︎

The full text where Textkernel found this language competency.

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

Country 🔗︎ string

Country🔗︎

The country that the military belongs to.

Service 🔗︎ object

Service🔗︎

The branch/name/rank for this post/job.


Service properties

Name 🔗︎ string

Name🔗︎

The name of the military post/job.

Branch 🔗︎ string

Branch🔗︎

The branch of the military.

Rank 🔗︎ string

Rank🔗︎

he military rank of the candidate.

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

FoundInContext 🔗︎ string

FoundInContext🔗︎

The full text where Textkernel found this military post/job in the resume.

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

Name 🔗︎ string

Name🔗︎

The name of the credential/clearance.

FoundInContext 🔗︎ string

FoundInContext🔗︎

The full context of where Textkernel found this clearance/credential.

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

ReferenceName 🔗︎ object

ReferenceName🔗︎

The name of the reference.


ReferenceName properties

FormattedName 🔗︎ string

FormattedName🔗︎

The name in a standard format.

Prefix 🔗︎ string

Prefix🔗︎

A prefix for a name, such as Dr.

GivenName 🔗︎ string

GivenName🔗︎

The given (first) name.

MiddleName 🔗︎ string

MiddleName🔗︎

The middle name or initial.

FamilyName 🔗︎ string

FamilyName🔗︎

The family (last) name.

Suffix 🔗︎ string

Suffix🔗︎

A suffix for a name, such as Jr. or III.

Title 🔗︎ string

Title🔗︎

The job title of the reference.

Company 🔗︎ string

Company🔗︎

The employer of the reference.

Location 🔗︎ object

Location🔗︎

The physical location of the reference.


Location properties

CountryCode 🔗︎ string

CountryCode🔗︎

The 2-letter ISO 3166 country code.

PostalCode 🔗︎ string

PostalCode🔗︎

The Postal or Zip code.

Regions 🔗︎ string[]

Regions🔗︎

The Regions/Districts/States.

Municipality 🔗︎ string

Municipality🔗︎

The City/Municipality/Town.

StreetAddressLines 🔗︎ string[]

StreetAddressLines🔗︎

Street address lines.

GeoCoordinates 🔗︎ object

GeoCoordinates🔗︎

If geocoding has been done, this is the lat/lon for the location.


GeoCoordinates properties

Latitude 🔗︎ decimal

Latitude🔗︎

The latitude, in degrees.

Longitude 🔗︎ decimal

Longitude🔗︎

The longitude, in degrees.

Source 🔗︎ string

Source🔗︎

The geocoding source, such as Google or Bing.

Telephones 🔗︎ object[]

Telephones🔗︎

Phone numbers listed for the reference.


Telephones properties

Raw 🔗︎ string

Raw🔗︎

The raw value found in the text.

Normalized 🔗︎ string

Normalized🔗︎

The normalized value.

EmailAddresses 🔗︎ string[]

EmailAddresses🔗︎

Email addresses listed for the reference.

WebAddresses 🔗︎ object[]

WebAddresses🔗︎

Other web addresses listed for the reference.


WebAddresses properties

Address 🔗︎ string

Address🔗︎

The URL or username

Type 🔗︎ string

Type🔗︎

The type of address. One of:

  • PersonalWebsite
  • LinkedIn
  • Twitter
  • GitHub
  • Facebook
  • Skype
  • WhatsApp
  • StackOverflow
  • Instagram
  • Reddit
  • Signal
  • Quora
  • ICQ
  • WeChat
  • QQ
  • Telegraph
  • Telegram
  • MeWe
  • Parler
  • Gab
  • Unknown
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

Text 🔗︎ string

Text🔗︎

The full text where we found all training history.

Trainings 🔗︎ object[]

Trainings🔗︎

Information about each training history we found.


Trainings properties

Text 🔗︎ string

Text🔗︎

The text that was found on the resume.

Entity 🔗︎ string

Entity🔗︎

The name of the school or company where the training occurred.

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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

EndDate 🔗︎ object

EndDate🔗︎

The date the training ended.


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

IsCurrentDate 🔗︎ bool

IsCurrentDate🔗︎

True if this date represents '- current' and not an actual date

FoundYear 🔗︎ bool

FoundYear🔗︎

True if the year was found in the text, otherwise false

FoundMonth 🔗︎ bool

FoundMonth🔗︎

True if the month was found in the text, otherwise false

FoundDay 🔗︎ bool

FoundDay🔗︎

True if the day was found in the text, otherwise false

Hobbies 🔗︎ string

Hobbies🔗︎

Any hobbies listed on the resume.

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

PlainText 🔗︎ string

PlainText🔗︎

The plain text that was used for parsing.

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.

ParserSettings 🔗︎ string

ParserSettings🔗︎

The full parser settings that were used during parsing.

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

FirstLineNumber 🔗︎ integer

FirstLineNumber🔗︎

The first line of the section (zero-based).

LastLineNumber 🔗︎ integer

LastLineNumber🔗︎

The last line of the section (zero-based).

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

HeaderTextFound 🔗︎ string

HeaderTextFound🔗︎

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"

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.

Identifiers 🔗︎ object[]

Identifiers🔗︎

Areas in the resume where this issue was found or affected by this issue.


Identifiers properties

SectionType 🔗︎ string

SectionType🔗︎

The section where the issue was found.

Id 🔗︎ string

Id🔗︎

If applicable, the Position ID or Education Id.

Message 🔗︎ string

Message🔗︎

A human-readable message explaining the issue that is being reported and possibly how to fix.

ReservedData 🔗︎ object

ReservedData🔗︎

Used by Textkernel to redact PII.


ReservedData properties

Phones 🔗︎ string[]

Phones🔗︎

All phone numbers found in the resume.

Names 🔗︎ string[]

Names🔗︎

All names found in the resume.

EmailAddresses 🔗︎ string[]

EmailAddresses🔗︎

All email addresses found in the resume.

Urls 🔗︎ string[]

Urls🔗︎

All personal urls found in the resume.

OtherData 🔗︎ string[]

OtherData🔗︎

Any other PII that should be redacted.

UserDefinedTags 🔗︎ string[]

UserDefinedTags🔗︎

A list of user-defined tags that are assigned to this resume. These are used to filter search/match queries in the Search & Match Engine.

NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.

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": {
    "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,
          "HasValue": 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"
          },
          "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"
              },
              "Type": "string"
            },
            "Majors": [
              "string"
            ],
            "Minors": [
              "string"
            ],
            "GPA": {
              "Score": "string",
              "ScoringSystem": "string",
              "MaxScore": "string",
              "MinimumScore": "string",
              "NormalizedScore": 0
            },
            "LastEducationDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "HasValue": 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": {
              "HasValue": true,
              "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,
              "HasValue": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "EndDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "HasValue": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "NumberEmployeesSupervised": {
              "HasValue": true,
              "Value": 0
            },
            "JobType": "string",
            "TaxonomyName": "string",
            "SubTaxonomyName": "string",
            "JobLevel": "string",
            "Description": "string",
            "Bullets": [
              {
                "Type": "string",
                "Text": "string"
              }
            ]
          }
        ]
      },
      "SkillsData": [
        {
          "Root": "string",
          "Taxonomies": [
            {
              "SubTaxonomies": [
                {
                  "Skills": [
                    {
                      "Variations": [
                        {
                          "MonthsExperience": {
                            "HasValue": true,
                            "Value": 0
                          },
                          "LastUsed": {
                            "Date": "2020-11-02",
                            "IsCurrentDate": true,
                            "HasValue": true,
                            "FoundYear": true,
                            "FoundMonth": true,
                            "FoundDay": true
                          },
                          "Id": "string",
                          "Name": "string",
                          "FoundIn": "string",
                          "ExistsInText": true
                        }
                      ],
                      "MonthsExperience": {
                        "HasValue": true,
                        "Value": 0
                      },
                      "LastUsed": {
                        "Date": "2020-11-02",
                        "IsCurrentDate": true,
                        "HasValue": true,
                        "FoundYear": true,
                        "FoundMonth": true,
                        "FoundDay": true
                      },
                      "Id": "string",
                      "Name": "string",
                      "FoundIn": "string",
                      "ExistsInText": true
                    }
                  ],
                  "PercentOfOverall": 0,
                  "PercentOfParent": 0,
                  "SubTaxonomyId": "string",
                  "SubTaxonomyName": "string"
                }
              ],
              "Id": "string",
              "Name": "string",
              "PercentOfOverall": 0
            }
          ]
        }
      ],
      "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,
            "HasValue": true,
            "FoundYear": true,
            "FoundMonth": true,
            "FoundDay": true
          },
          "EndDate": {
            "Date": "2020-11-02",
            "IsCurrentDate": true,
            "HasValue": 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,
              "HasValue": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "EndDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "HasValue": 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": 0,
                "Identifiers": [
                  "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"
      ]
    }
  }
}