Skip to content
Tx Platform
Parse API

Parse a JobπŸ”—︎

HTTP Verb Path
POST /v10/parser/joborder

Parse a single Job.

Info

  • You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
  • This service is designed to parse jobs. It assumes that all files passed to it are jobs. It does not attempt to detect whether a document is a job 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-job 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 job file.
  • In order to provide parsing for a wide range of languages, the parser does not provide the full data model 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.

Request BodyπŸ”—︎

DocumentAsBase64String πŸ”—︎ string required

DocumentAsBase64StringπŸ”—︎

A Base64 encoded string of the job 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 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.JobData.Skills.Normalized. Read moreabout the benefits of using a skills taxonomy.- 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 - !!! danger "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).
  • 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 πŸ”—︎ string

NormalizeπŸ”—︎

When true, the job title 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 profession 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.

Version πŸ”—︎ object

VersionπŸ”—︎

Specifies the versions to use when normalizing professions if more than one is available for a taxonomy.


Version properties

.ONET πŸ”—︎ string

.ONETπŸ”—︎

The ONET Version to use when normalizing professions. One of:

  • 2010
  • 2019

This parameter defaults to "2010".

DocumentLastModified πŸ”—︎ string required

DocumentLastModifiedπŸ”—︎

Mandatory date, in YYYY-MM-DD format, representing the "current" or "as of" date used during parsing. This is useful when parsing older documents. Read more about this here.

OutputHtml πŸ”—︎ boolean

OutputHtmlπŸ”—︎

When true, the original file is converted to HTML and stored in the Html property.

OutputRtf πŸ”—︎ boolean

OutputRtfπŸ”—︎

When true, the original file is converted to RTF and stored in the Rtf property.

OutputPdf πŸ”—︎ boolean

OutputPdfπŸ”—︎

When true, the original file is converted to PDF and stored in the Pdf property as a byte array.

Configuration πŸ”—︎ object

ConfigurationπŸ”—︎

Deprecated

SkillsData πŸ”—︎ string[]

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.

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.

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

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

Latitude πŸ”—︎ float

LatitudeπŸ”—︎

The latitude coordinate value.

Longitude πŸ”—︎ float

LongitudeπŸ”—︎

The longitude coordinate value.

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.

UserDefinedTags πŸ”—︎ string[]

UserDefinedTagsπŸ”—︎

The User-Defined Tags you want the document to have.

Sample JSON
{
  "DocumentAsBase64String": "",
  "SkillsSettings": {
    "Normalize": false,
    "TaxonomyVersion": ""
  },
  "ProfessionsSettings": {
    "Normalize": false,
    "Version": {
      "ONET": "2019"
    }
  },
  "DocumentLastModified": "",
  "OutputHtml": false,
  "OutputRtf": false,
  "OutputPdf": false,
  "Configuration": {
    "CountryCode": "",
    "Language": "",
    "KnownType": "",
    "IncludeRecruitingTerms": false,
    "IncludeSupplementalText": false,
    "PreferShorterJobTitles": false
  },
  "GeocodeOptions": {
    "IncludeGeocoding": false,
    "Provider": "",
    "ProviderKey": "",
    "PostalAddress": {
      "CountryCode": "",
      "PostalCode": "",
      "Region": "",
      "Municipality": "",
      "AddressLine": ""
    },
    "GeoCoordinates": {
      "Latitude": 0,
      "Longitude": 0
    }
  },
  "IndexingOptions": {
    "IndexId": "",
    "DocumentId": "",
    "UserDefinedTags": [
      ""
    ]
  },
  "SkillsData": [
    ""
  ]
}

Response BodyπŸ”—︎

Info πŸ”—︎ object

InfoπŸ”—︎

Information explaining the outcome of the transaction.


Info properties

Code πŸ”—︎ string

CodeπŸ”—︎

Code Description
Success Successful transaction
PossibleTruncationFromTimeout The timeout occurred before the document was finished parsing which can result in truncation
ConversionException There was an issue converting the document
MissingParameter A required parameter wasn't provided
InvalidParameter A parameter was incorrectly specified
AuthenticationError An error occurred with the credentials provided
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

ParsingResponse πŸ”—︎ object

ParsingResponseπŸ”—︎

The status of the parse transaction.


ParsingResponse properties

Code πŸ”—︎ string

CodeπŸ”—︎

See HTTP status codes.

Message πŸ”—︎ string

MessageπŸ”—︎

A short human-readable description explaining the Code value.

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πŸ”—︎

See HTTP status codes

Message πŸ”—︎ string

MessageπŸ”—︎

A short human-readable description explaining the Code value.

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πŸ”—︎

See HTTP status codes.

Message πŸ”—︎ string

MessageπŸ”—︎

A short human-readable description explaining the Code value.

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

Code πŸ”—︎ string

CodeπŸ”—︎

Code Description
Success Successful transaction
Unhandled Exception Unhandled Exception
Message πŸ”—︎ string

MessageπŸ”—︎

A short human-readable description explaining the Code value.

JobData πŸ”—︎ object

JobDataπŸ”—︎

The main output from the Textkernel Job Parser.


JobData properties

CurrentJobIsManagement πŸ”—︎ bool

CurrentJobIsManagementπŸ”—︎

Whether or not the job is a management position. Used by Textkernel for Search & Match.

HighestManagementScore πŸ”—︎ object

HighestManagementScoreπŸ”—︎

The management score, or null. Used by Textkernel for Search & Match.


HighestManagementScore properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The management score.

ManagementLevel πŸ”—︎ string

ManagementLevelπŸ”—︎

The management level. Used by Textkernel for Search & Match. One of:

  • None
  • Low
  • Mid
  • High
ExecutiveType πŸ”—︎ string

ExecutiveTypeπŸ”—︎

What kind of executive position the job is, if any. Used by Textkernel for Search & Match. One of:

  • NONE
  • ADMIN
  • ACCOUNTING
  • BUSINESS_DEV
  • EXECUTIVE
  • FINANCIAL
  • GENERAL
  • IT
  • LEARNING
  • MARKETING
  • OPERATIONS
MinimumYears πŸ”—︎ object

MinimumYearsπŸ”—︎

The minimum years experience for the job, or null. Used by Textkernel for Search & Match.


MinimumYears properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The minimum years experience for the job.

MaximumYears πŸ”—︎ object

MaximumYearsπŸ”—︎

The maximum years experience for the job, or null. Used by Textkernel for Search & Match.


MaximumYears properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The maximum years experience for the job.

MinimumYearsManagement πŸ”—︎ object

MinimumYearsManagementπŸ”—︎

The minimum years of management experience, or null. Used by Textkernel for Search & Match.


MinimumYearsManagement properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The minimum years of management experience.

MaximumYearsManagement πŸ”—︎ object

MaximumYearsManagementπŸ”—︎

The maximum years of management experience, or null. Used by Textkernel for Search & Match.


MaximumYearsManagement properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The maximum years of management experience.

RequiredDegree πŸ”—︎ string

RequiredDegreeπŸ”—︎

The required educational degree, if listed. Used by Textkernel for Search & Match.

JobDescription πŸ”—︎ string

JobDescriptionπŸ”—︎

Section containing information about the job. Job description strictly includes duties, tasks, and responsibilities for the role with as little irrelevant text as possible.

JobRequirements πŸ”—︎ string

JobRequirementsπŸ”—︎

Full text of any requirements listed by the job.

Benefits πŸ”—︎ string

BenefitsπŸ”—︎

Full text of any benefits listed by the job.

EmployerDescription πŸ”—︎ string

EmployerDescriptionπŸ”—︎

Full text of any employer description listed by the job.

StartDate πŸ”—︎ object

StartDateπŸ”—︎

The start date of the job.

JobTitles πŸ”—︎ object

JobTitlesπŸ”—︎

The job titles found in the job. Used by Textkernel for Search & Match.


JobTitles properties

MainJobTitle πŸ”—︎ string

MainJobTitleπŸ”—︎

The main/overall job title.

JobTitle πŸ”—︎ string[]

JobTitleπŸ”—︎

All job titles found in 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

EmployerNames πŸ”—︎ object

EmployerNamesπŸ”—︎

The employer names found in the job.


EmployerNames properties

MainEmployerName πŸ”—︎ string

MainEmployerNameπŸ”—︎

The main/overall employer name.

EmployerName πŸ”—︎ string[]

EmployerNameπŸ”—︎

All employer names found in a job description.

Degrees πŸ”—︎ object[]

DegreesπŸ”—︎

The educational degrees found listed in the job. Used by Textkernel for Search & Match.


Degrees properties

Name πŸ”—︎ string

NameπŸ”—︎

The name of the educational degree.

Type πŸ”—︎ string

TypeπŸ”—︎

The type of the educational degree.

LocalEducationLevel πŸ”—︎ string

LocalEducationLevelπŸ”—︎

The normalized, local education level based on the job's country. Returns the Code ID from the table below.

Code ID Description
AT_0 Unbekannt
AT_1 Volksschule
AT_10 Fachhochschule
AT_11 Akademie
AT_12 UniversitΓ€t
AT_13 Post-Akademische Ausbildung
AT_14 Dissertation
AT_2 Hauptschule
AT_3 AHS Unterstufe
AT_4 Lehre
AT_5 BMS
AT_6 BHS
AT_7 AHS Oberstufe
AT_8 Werkmeister- und Meisterschule
AT_9 Kolleg
BE_0 Onbekend
BE_1 Doctoraat
BE_10 Beroepssecundair onderwijs
BE_11 Technisch secundair onderwijs
BE_12 Lager onderwijs
BE_13 Andere
BE_14 Hoger beroepsonderwijs
BE_3 Master
BE_4 Bachelor/Master
BE_5 Academische/Professionele bachelor
BE_6 Academische bachelor
BE_7 Professionele bachelor
BE_8 Algemeen secundair onderwijs
BE_9 Kunstsecundair onderwijs
BR_0 Desconocido
BR_1 Ensino fundamentele
BR_2 Ensino secundΓ‘rio
BR_3 Licenciatura
BR_4 Mestrado
BR_5 Doutoramento
CA_0 Unknown
CA_1 High School
CA_2 Vocational Certificate
CA_3 Bachelor's Degree
CA_4 Master's Degree
CA_5 Ph.D.
CH_0 Andere/Unbekannt
CH_1 Primarschule
CH_10 Post-doc
CH_2 Sekundarschule
CH_3 Berufliche Grundbildung
CH_4 Allgemeinbildende Schulen
CH_5 HΓΆhere Berufsbildung
CH_6 Hochschule
CH_7 Nachdiplomausbildung
CH_8 Masterstudium
CH_9 Doktorat
CN_0 无要求
CN_1 小学
CN_2 δΈ­ε­¦
CN_3 θŒδΈšζ•™θ‚²
CN_4 倧学
CN_5 瑕士
CN_6 博士
CZ_0 Unknown
CZ_1 ZΓ‘kladnΓ­ Ε‘kola
CZ_2 SOU
CZ_3 GymnΓ‘zium
CZ_4 DiS / Vos
CZ_5 BakalΓ‘Ε™
CZ_6 Magistr
CZ_7 Doctorat
DE_0 Unbekannt
DE_1 Grundschule
DE_2 Hauptschule
DE_3 Realschule
DE_4 Gymnasium
DE_5 Fachschule/Berufsausbildung
DE_6 Meister
DE_7 Bachelor
DE_8 Master
DE_9 Dissertation
DK_0 Unknown
DK_1 Folkeskole
DK_2 Gymnasie
DK_3 Professional Higher
DK_4 Bachelor
DK_5 Candidatus / Master
DK_6 Ph.D.
DK_7 Universitet
ES_0 Desconocido
ES_1 Bachillerato
ES_2 FormaciΓ³n Profesional
ES_3 Grado
ES_4 Licenciatura
ES_5 Doctorado
FI_0 No Degree
FI_1 Basic Education
FI_10 PhD
FI_2 Vocational Upper Secondary
FI_3 Upper Secondary School
FI_4 University Degree
FI_5 Bachelor Polytechnic
FI_6 Bachelor
FI_7 Engineer
FI_8 Master
FI_9 Pre-doctoral Degree
FR_0 Unknown
FR_1 Elementary
FR_10 Bac+3/+4
FR_11 Bac+3/+5
FR_12 Bac+4
FR_13 Bac+4/+5
FR_14 Bac+5
FR_15 Bac+8
FR_2 BEP/CAP
FR_3 Bac Pro
FR_4 Bac
FR_5 Bac+2
FR_6 Bac+2/+3
FR_7 Bac+2/+4
FR_8 Bac+2/+5
FR_9 Bac+3
GB_0 Unknown
GB_1 Post-Graduate qualification
GB_2 Master's degree
GB_3 Bachelor's degree
GB_4 Professional qualification
GB_5 HND/HNC or equivalent
GB_6 Vocational qualification (NVQ/VRQ/QCF)
GB_7 'A' Level or equivalent
GB_8 GCSE or equivalent
GB_9 Other
GR_0 Unknown
GR_1 Primary School
GR_2 Lower Secondary School
GR_3 Upper Secondary School
GR_4 Bachelor
GR_5 Master
GR_6 Doctorate
HR_0 Bez diplome
HR_1 Osnovna Ε‘kola
HR_2 Srednja stručna sprema
HR_3 Viőa stručna sprema
HR_4 Visoka stručna sprema
HR_5 Poslijediplomski znanstveni magistarski studiji
HR_6 Doktor znanosti
HU_0 Unknown
HU_1 ÁltalÑnos Iskola
HU_2 Szakiskola
HU_3 GimnΓ‘zium
HU_4 FΕ‘iskola
HU_5 Egyetem- BSc, BA
HU_6 Egyetem- MSc, MA, osztatlan
HU_7 PosztgraduΓ‘lis kΓ©pzΓ©s
HU_8 PhD
IT_0 Corsi
IT_1 Scuola della infanzia
IT_2 Scuola elementare
IT_3 Scuola secondaria di primo grado
IT_4 Scuola secondaria di secondo grado
IT_5 Laurea triennale
IT_6 Master I livello
IT_7 Laurea specialistica
IT_8 Master II livello
IT_9 Dottorato di ricerca
JP_0 γƒͺγ‚―γ‚¨γ‚Ήγƒˆγͺし
JP_1 小学树
JP_2 δΈ­η­‰ε­¦ζ ‘
JP_3 職ζ₯­ζ•™θ‚²
JP_4 倧学
JP_5 γƒžγ‚Ήγ‚ΏγƒΌ
JP_6 博士号
NL_0 Onbekend
NL_1 Elementair
NL_10 MBO/HBO
NL_11 HBO
NL_12 HBO/WO
NL_13 WO
NL_14 Post WO
NL_2 VMBO
NL_3 VMBO/MBO
NL_4 Mavo/VMBO
NL_5 VMBO/Havo
NL_6 HAVO
NL_7 HAVO/VWO
NL_8 Vwo
NL_9 MBO
NO_0 Unknown
NO_1 Primary School
NO_2 Lower Secondary School
NO_3 Upper Secondary School
NO_4 Vocational Education
NO_5 Bachelor
NO_6 Master
NO_7 Doctorate
NO_8 University
PL_0 Unknown
PL_1 Szkola Podstawowa
PL_2 Gimnazjum
PL_3 Liceum
PL_4 Bachelor
PL_5 Magister
PL_6 Doktor
PT_0 Desconocido
PT_1 Ensino fundamentele
PT_2 Ensino medio
PT_3 Licenciatura
PT_4 Mestre
PT_5 Doutor
RO_0 Unknown
RO_1 Scoala Primara
RO_2 Gimnaziu
RO_3 Liceu
RO_4 Scoala Postliceala
RO_5 Diplomă de Licenţă
RO_6 Master
RO_7 PhD
RU_0 Unknown
RU_1 Primary school
RU_2 Secondary school
RU_3 Prof. Qualification
RU_4 Bachelor
RU_5 Master
RU_6 PhD
SE_0 Unknown
SE_1 Grundskola
SE_2 Gymnasieskola
SE_3 HΓΆgskolexamen
SE_4 Kandidat
SE_5 Master
SE_6 Universitet-Licenciat-PhD
SI_0 Brez stopnje
SI_1 OsnovnoΕ‘olska izobrazba
SI_2 SrednjeΕ‘olska izobrazba
SI_3 Dodiplomski Ε‘tudij
SI_4 Magister
SI_5 Magisterij znanosti
SI_6 Doktor znanosti
SK_0 Unknown
SK_1 ZΓ‘kladnΓ© Vzdelanie
SK_2 Stredoőkolské Vzdelanie Alebo Odborné Vyučenie
SK_3 VysokoΕ‘kolskΓ©/UniverzitnΓ© Vzdelanie
SK_4 PostgraduΓ‘lne Ε tΓΊdium
TR_0 Diğer/Bilinmiyor
TR_1 İlkâğretim
TR_2 Lise
TR_3 Γ–nlisans
TR_4 Lisans
TR_5 YΓΌksek Lisans
TR_6 Doktora
TR_7 Doktora sonrasΔ±
US_1 Post-Doctorate Qualification
US_2 PhD
US_3 Master
US_4 Bachelor
US_5 Associate Degree
US_6 Vocational Certificate
US_7 College
US_8 High School
US_9 Unknown
SchoolNames πŸ”—︎ string[]

SchoolNamesπŸ”—︎

Any school names listed in the job.

CertificationsAndLicenses πŸ”—︎ string[]

CertificationsAndLicensesπŸ”—︎

Any certifications/licenses listed in the job. Used by Textkernel for Search & Match.

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.

Required πŸ”—︎ bool

RequiredπŸ”—︎

True if this skill was listed as 'required' on the job description.

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

Type πŸ”—︎ string

TypeπŸ”—︎

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

Id πŸ”—︎ string

IdπŸ”—︎

Id of this skill in the skills taxonomy

Required πŸ”—︎ bool

RequiredπŸ”—︎

True if this skill was listed as 'required' on the job description.

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.

LanguageCodes πŸ”—︎ string[]

LanguageCodesπŸ”—︎

Any languages listed in the job. Used by Textkernel for Search & Match.

CurrentLocation πŸ”—︎ object

CurrentLocationπŸ”—︎

The location of the job, if listed. If no job location is found, this is the location of the company, if listed.


CurrentLocation 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.

ApplicationDetails πŸ”—︎ object

ApplicationDetailsπŸ”—︎

Information about the application process.


ApplicationDetails properties

ApplicationDescription πŸ”—︎ string

ApplicationDescriptionπŸ”—︎

Full text description of the application process.

ContactPerson πŸ”—︎ string

ContactPersonπŸ”—︎

Full name of the main contact person for the application.

ContactPhone πŸ”—︎ string

ContactPhoneπŸ”—︎

Normalized phone of the organization with international calling prefix. Can contain multiple values (concatenated by comma).

ContactEmail πŸ”—︎ string

ContactEmailπŸ”—︎

Displayable email of the organization. Can contain multiple values (concatenated by comma).

Website πŸ”—︎ string

WebsiteπŸ”—︎

Validated and normalized displayable website of the organization. Can contain multiple values (concatenated by comma)

ApplicationDeadline πŸ”—︎ Date

ApplicationDeadlineπŸ”—︎

Deadline to apply for the job.

PostedDate πŸ”—︎ Date

PostedDateπŸ”—︎

Date the job was posted.

ReferenceNumber πŸ”—︎ string

ReferenceNumberπŸ”—︎

Any reference number found for the job application.

Salary πŸ”—︎ object

SalaryπŸ”—︎

The salary found for the position If no lexical cues are available from the vacancy, the time scale is guessed based on predefined salary ranges. Here are some rough salary ranges (note: country-specific conditions may apply):

  • 1 or 2 digits salary (9, 12): hourly
  • 3 or 4 digits salary (3800, 5000): monthly
  • 5 digit salary (38000, 50000): yearly

If a monthly salary is extracted, to get the annual salary it is multiplied by 14 (if country = AT) or 12 (all other countries).


Salary properties

Minimum πŸ”—︎ object

MinimumπŸ”—︎

The normalized minimum yearly salary.


Minimum properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The value of the normalized minimum yearly salary.

Maximum πŸ”—︎ object

MaximumπŸ”—︎

The normalized maximum yearly salary.


Maximum properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The value of the normalized maximum yearly salary.

RawMinimum πŸ”—︎ string

RawMinimumπŸ”—︎

The raw, un-normalized, minimum value. This is returned as is in the text, so there is no guarantee that it will evaluate to a valid number and not a string.

RawMaximum πŸ”—︎ string

RawMaximumπŸ”—︎

The raw, un-normalized, maximum value. This is returned as is in the text, so there is no guarantee that it will evaluate to a valid number and not a string.

Currency πŸ”—︎ string

CurrencyπŸ”—︎

Currency code (ISO 4217) applied to the Minimum and Maximum

MinimumWorkingHours πŸ”—︎ object

MinimumWorkingHoursπŸ”—︎

The minimum number of working hours per week, or null.


MinimumWorkingHours properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The minimum number of working hours per week.

MaximumWorkingHours πŸ”—︎ object

MaximumWorkingHoursπŸ”—︎

The maximum number of working hours per week, or null.


MaximumWorkingHours properties

Value πŸ”—︎ integer

ValueπŸ”—︎

The maximum number of working hours per week.

WorkingHours πŸ”—︎ string

WorkingHoursπŸ”—︎

The type of working hours. One of:

  • regular
  • irregular
IsRemote πŸ”—︎ bool

IsRemoteπŸ”—︎

Whether or not the position is remote. Includes fulltime, partial and temporary remote working opportunities.

DriversLicenses πŸ”—︎ string[]

DriversLicensesπŸ”—︎

Any drivers license requirements.

EmploymentType πŸ”—︎ string

EmploymentTypeπŸ”—︎

The type of employment. One of:

  • unspecified
  • fulltime
  • parttime
  • fulltime/parttime
ContractType πŸ”—︎ string

ContractTypeπŸ”—︎

The contract type. One of:

  • unspecified
  • permanent
  • temporary
  • possibly_permanent
  • interim
  • franchise
  • side
  • internship
  • voluntary
  • freelance
  • apprenticeship
  • assisted
TermsOfInterest πŸ”—︎ string[]

TermsOfInterestπŸ”—︎

Terms of interest listed in the job.

Owners πŸ”—︎ string[]

OwnersπŸ”—︎

Any owners of the job posting, if listed.

SkillsData πŸ”—︎ object[]

SkillsDataπŸ”—︎

Deprecated. Use v2 skills taxonomy and its associated Skills output.

JobMetadata πŸ”—︎ object

JobMetadataπŸ”—︎

Metadata about the parsed job


JobMetadata properties

PlainText πŸ”—︎ string

PlainTextπŸ”—︎

The plain text that was used for parsing.

DocumentLanguage πŸ”—︎ string

DocumentLanguageπŸ”—︎

The two-letter ISO 639-1 code for the language the document was written in.

DocumentCulture πŸ”—︎ string

DocumentCultureπŸ”—︎

The xx-XX language/culture value for the parsed document.

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.

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.

ConversionMetadata πŸ”—︎ object

ConversionMetadataπŸ”—︎

Information about converting the document to plain text


ConversionMetadata properties

DetectedType πŸ”—︎ string

DetectedTypeπŸ”—︎

The file type that was detected.

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.

ElapsedMilliseconds πŸ”—︎ string

ElapsedMillisecondsπŸ”—︎

How long the document conversion took, in milliseconds.

DocumentHash πŸ”—︎ string

DocumentHashπŸ”—︎

The MD5 hash of the document bytes.

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.

RTF πŸ”—︎ string

RTFπŸ”—︎

If requested by ParseOptions.OutputRtf, this is the document converted to RTF.

CandidateImage πŸ”—︎ string

CandidateImageπŸ”—︎

If a candidate photo was extracted, it will be output here. This is a byte[] as a Base64-encoded string.

CandidateImageExtension πŸ”—︎ string

CandidateImageExtensionπŸ”—︎

If a candidate photo was extracted, the appropriate file extension for the photo will be output for this field (e.g. ".png").

ParsingMetadata πŸ”—︎ object

ParsingMetadataπŸ”—︎

Information about the parsing transaction.


ParsingMetadata properties

ElapsedMilliseconds πŸ”—︎ string

ElapsedMillisecondsπŸ”—︎

How long it took to parse the document, in milliseconds.

TimedOut πŸ”—︎ bool

TimedOutπŸ”—︎

Whether or not the transaction timed out. If this is true, the returned data may be incomplete.

TimedOutAtMilliseconds πŸ”—︎ object

TimedOutAtMillisecondsπŸ”—︎

If TimedOut is true, this is how much time was spent parsing before the timeout occurred. Otherwise null.


TimedOutAtMilliseconds properties

Value πŸ”—︎ integer

ValueπŸ”—︎

If TimedOut is true, this is how much time was spent parsing before the timeout occurred.

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": {
    "JobData": {
      "CurrentJobIsManagement": true,
      "HighestManagementScore": {
        "Value": 0
      },
      "ManagementLevel": "string",
      "ExecutiveType": "string",
      "MinimumYears": {
        "Value": 0
      },
      "MaximumYears": {
        "Value": 0
      },
      "MinimumYearsManagement": {
        "Value": 0
      },
      "MaximumYearsManagement": {
        "Value": 0
      },
      "RequiredDegree": "string",
      "JobDescription": "string",
      "JobRequirements": "string",
      "Benefits": "string",
      "EmployerDescription": "string",
      "StartDate": {
        "Value": "2020-11-02"
      },
      "JobTitles": {
        "MainJobTitle": "string",
        "JobTitle": [
          "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
        }
      },
      "EmployerNames": {
        "MainEmployerName": "string",
        "EmployerName": [
          "string"
        ]
      },
      "Degrees": [
        {
          "Name": "string",
          "Type": "string",
          "LocalEducationLevel": "string"
        }
      ],
      "SchoolNames": [
        "string"
      ],
      "CertificationsAndLicenses": [
        "string"
      ],
      "Skills": {
        "Raw": [
          {
            "Name": "",
            "Required": false
          }
        ],
        "Normalized": [
          {
            "Name": "",
            "Type": "",
            "Id": "",
            "Required": false,
            "RawSkills": [
              ""
            ]
          }
        ],
        "RelatedProfessionClasses": [
          {
            "Name": "",
            "Id": "",
            "Percent": 0,
            "Groups": [
              {
                "Name": "",
                "Id": "",
                "Percent": 0,
                "NormalizedSkills": [
                  ""
                ]
              }
            ]
          }
        ]
      },
      "LanguageCodes": [
        "string"
      ],
      "CurrentLocation": {
        "CountryCode": "string",
        "PostalCode": "string",
        "Regions": [
          "string"
        ],
        "Municipality": "string",
        "StreetAddressLines": [
          "string"
        ],
        "GeoCoordinates": {
          "Latitude": 0,
          "Longitude": 0,
          "Source": "string"
        }
      },
      "ApplicationDetails": {
        "ApplicationDescription": "string",
        "ContactPerson": "string",
        "ContactPhone": "string",
        "ContactEmail": "string",
        "Website": "string",
        "ApplicationDeadline": {
          "Value": "2020-11-02"
        },
        "PostedDate": {
          "Value": "2020-11-02"
        },
        "ReferenceNumber": "string"
      },
      "Salary": {
        "Minimum": {
          "Value": 0
        },
        "Maximum": {
          "Value": 0
        },
        "RawMinimum": "string",
        "RawMaximum": "string",
        "Currency": "string"
      },
      "MinimumWorkingHours": {
        "Value": 0
      },
      "MaximumWorkingHours": {
        "Value": 0
      },
      "WorkingHours": "string",
      "IsRemote": true,
      "DriversLicenses": [
        "string"
      ],
      "EmploymentType": "string",
      "ContractType": "string",
      "TermsOfInterest": [
        "string"
      ],
      "Owners": [
        "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",
                      "ExistsInText": true,
                      "Required": true,
                      "Variations": [
                        {
                          "Id": "string",
                          "Name": "string",
                          "ExistsInText": true,
                          "Required": true
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "JobMetadata": {
        "PlainText": "string",
        "DocumentLanguage": "string",
        "DocumentCulture": "string",
        "ParserSettings": "string",
        "DocumentLastModified": "2020-11-02"
      },
      "UserDefinedTags": [
        "string"
      ]
    },
    "ParsingResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "GeocodeResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "IndexingResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "ProfessionNormalizationResponse": {
      "Code": "Success",
      "Message": "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
      }
    }
  }
}