CV/Resume parsing data model🔗

This page describes all the fields returned by the Textkernel parser product for CV/resume parsing.

Naming convention

To enhance clarity, this documentation employs the term candidate to encompass individuals such as candidates, applicants, employees, and other talents.

Document Information🔗

Document Language string

The language of the document, as detected by the parsing models.

XML path: //Profile/@lang
JSON path: $.lang

Document Language Code string

The language of the document normalized to the ISO 639-1 classification, as detected by the parsing models.

XML path: //Profile/@langCode
JSON path: $.langCode

Filename string

The name of the parsed binary document, if provided as input to the parsing endpoint, null otherwise.

XML path: //Profile/@file
JSON path: $.file

Document Last Modified Date date

The last date/time the binary document was edited, if the binary document contains that metadata information, in the format YYYY-MM-DDThh:mm.

XML path: //Profile/@lastmodified
JSON path: $.lastModified

Partial Extraction Indicator string

Indicates whether the full document document was used for extraction. Returns 1 if the document was so long and only part of it was used for extraction, otherwise 0 if the whole document was used.

XML path: //Profile/@partialExtractionIndicator
JSON path: $.partialExtractionIndicator

Example JSON/XML

JSONXML

{
    "lang": "english",
    "file": "candidate.pdf",
    "partialExtractionIndicator": "0",
    "langCode": "en",
    "lastModified": "2021-09-16T08:42"
}

<Profile lang="english" file="candidate.pdf"
        partialExtractionIndicator="0" langCode="en"
        lastmodified="2021-09-16T08:42">

Summary of Profile🔗

Years of Experience numeric

The total experience of the candidate in years, calculated based on the work history from the document.

XML path: //Summary/TotalExperienceYears
JSON path: $.summary.totalExperienceYears

Months of Experience numeric

The total experience of the candidate in months, calculated based on the work history from the document.

XML path: //Summary/TotalExperienceMonths
JSON path: $.summary.totalExperienceMonths

Current Job string

The current/latest job position held by the candidate, calculated based on the work history from the document.

XML path: //Summary/CurrentJob
JSON path: $.summary.currentJob

Current Employer string

The employer of the current/latest job position held by the candidate, calculated based on the work history from the document.

XML path: //Summary/CurrentEmployer
JSON path: $.summary.currentEmployer

Current Work Field string, string Add-on required

The work field of the current/latest job of the candidate, calculated based on current/latest job title and normalized to the Textkernel Professions Taxonomy.

Note: This field requires the Profession Classification add-on.

XML path:
- //Summary/CurrentWorkField/WorkFieldCode
- //Summary/CurrentWorkField/WorkFieldDescription
JSON path:
- $.summary.currentWorkField.workFieldCode
- $.summary.currentWorkField.workFieldDescription

Current Work Field Experience Level string, string Add-on required

The level of experience of the candidate in the current work field, normalized to the Textkernel Experience Level classification.

Note: This field requires the Profession Classification add-on.

XML path:
- //Summary/CurrentWorkField/ExperienceLevelCode
- //Summary/CurrentWorkField/ExperienceLevelDescription
JSON path:
- $.summary.currentWorkField.experienceLevelCode
- $.summary.currentWorkField.experienceLevelDescription

Highest Education Level - Local string, string

The highest level of education obtained by the candidate, calculated based on the education history from the document, and normalized to the Textkernel Local Education Level classification.

XML path:
- //Summary/HighestDegree/LocalCode
- //Summary/HighestDegree/LocalDescription
JSON path:
- $.summary.highestDegree.localCode
- $.summary.highestDegree.localDescription

Highest Education Level - International string, string

The highest level of education obtained by the candidate, calculated based on the education history from the document, and normalized to the Textkernel International Education Level classification.

XML path:
- //Summary/HighestDegree/InternationalCode
- //Summary/HighestDegree/InternationalDescription
JSON path:
- $.summary.highestDegree.internationalCode
- $.summary.highestDegree.internationalDescription

Highest Education Level - End Date date

The graduation date of the highest degree mentioned in the document, in the format YYYY-MM-DD. If the degree is still ongoing, the placeholder __NOWSTRING__ is returned.

XML path: //Summary/HighestDegree/EndDate
JSON path: $.summary.highestDegree.endDate

Summary/Ambitions Section string

A section of the document detailing the candidate's ambitions and aspirations.

XML path: //Summary/SummaryAmbitionSection
JSON path: $.summary.summaryAmbitionSection

Extracurricular Section string

A section of the document detailing activities, interests, voluntary work or pursuits done by the candidate.

XML path: //Summary/ExtraCurricularSection
JSON path: $.summary.extraCurricularSection

Example JSON/XML

JSONXML

{
    "summary": {
        "totalExperienceYears": "27",
        "totalExperienceMonths": "327",
        "currentJob": "Senior Credit Analyst",
        "currentEmployer": "Textkernel BV",
        "currentWorkField": {
            "workFieldCode": "254",
            "workFieldDescription": "Financial Experts",
            "experienceLevelCode": "CV_5_EXPERT",
            "experienceLevelDescription": "Expert"
        },
        "highestDegree": {
            "localCode": "US_3",
            "localDescription": "Master",
            "internationalCode": "4",
            "internationalDescription": "Master",
            "endDate": "2000-06-30"
        },
        "summaryAmbitionSection": "Summary: A proactive and ambitious individual with experience in Customer Service, Researching...",
        "extraCurricularSection": "Hobbies: Gardening, reading..."
    }
}

<Profile>
    <Summary>
        <TotalExperienceYears>27</TotalExperienceYears>
        <TotalExperienceMonths>327</TotalExperienceMonths>
        <CurrentJob>Senior Credit Analyst</CurrentJob>
        <CurrentEmployer>Textkernel BV</CurrentEmployer>
        <CurrentWorkField>
            <WorkFieldCode>254</WorkFieldCode>
            <WorkFieldDescription>Financial Experts</WorkFieldDescription>
            <ExperienceLevelCode>CV_5_EXPERT</ExperienceLevelCode>
            <ExperienceLevelDescription>Expert</ExperienceLevelDescription>
        </CurrentWorkField>
        <HighestDegree>
            <LocalCode>US_3</LocalCode>
            <LocalDescription>Master</LocalDescription>
            <InternationalCode>4</InternationalCode>
            <InternationalDescription>Master</InternationalDescription>
            <EndDate>2000-06-30</EndDate>
        </HighestDegree>
        <SummaryAmbitionSection>Summary: A proactive and ambitious individual with experience in Customer Service, Researching...</SummaryAmbitionSection>
        <ExtraCurricularSection>Hobbies: Gardening, reading...</ExtraCurricularSection>
    </Summary>
</Profile>

Contact Details🔗

Title string

The title of the candidate. E.g. Drs.

XML path: //Personal/Title
JSON path: $.personal.title

First Name string

The first name of the candidate.

XML path: //Personal/FirstName
JSON path: $.personal.firstName

Middle Name string

The middle name of the candidate.

XML path: //Personal/MiddleName
JSON path: $.personal.middleName

Last Name string

The family name of the candidate.

XML path: //Personal/LastName
JSON path: $.personal.lastName

Complete Name string

The name of the candidate, composed by first name and last name.

XML path: //Personal/CompleteName
JSON path: $.personal.completeName

Initials string

The initials of the first and middle name of the candidate.

XML path: //Personal/Initials
JSON path: $.personal.initials

Date of Birth date

The date of birth of the candidate, in the format YYYY-MM-DD.

XML path: //Personal/BirthDate
JSON path: $.personal.birthDate

Place of Birth string

The place of birth of the candidate, as found in the CV.

XML path: //Personal/BirthPlace
JSON path: $.personal.birthPlace

Nationality string, string

The nationality of the candidate, normalized to the ISO 3166-1 alpha-2 classification.

XML path:
- //Personal/Nationality/NationalityCode
- //Personal/Nationality/NationalityDescription
JSON path:
- $.personal.nationality.code
- $.personal.nationality.description

National ID string

The ID number of the candidate, as found in the CV. Only extracted from CVs from Spain, Chile, Colombia, Israel and South Africa.

XML path: //Personal/NationalID
JSON path: $.personal.nationalId

Gender string, string

The gender of the candidate, normalized to the ISO 5218.

XML path:
- //Personal/Gender/GenderCode
- //Personal/Gender/GenderDescription
JSON path:
- $.personal.gender.code
- $.personal.gender.description

Driver's License string

The diver licenses of the candidate, as extracted from the document.

XML path: //Personal/DriversLicenses[]/DriversLicense
JSON path: $.personal.driversLicenses[].driversLicense

Geo coordinates coordinates Add-on required

The geo coordinates of the address of the candidate, in decimal degrees format.

Note: This field requires the Geocoding add-on.

XML path:
- //Personal/Address/Latitude
- //Personal/Address/Longitude
JSON path:
- $.personal.address.latitude
- $.personal.address.longitude

Address Line string

The complete address line containing street name, number, appartment number.

XML path: //Personal/Address/AddressLine
JSON path: $.personal.address.addressLine

Street Name string

The street name of the candidate's address.

XML path: //Personal/Address/Street
JSON path: $.personal.address.street

Street Number string

The street number of the candidate's address.

XML path: //Personal/Address/Number
JSON path: $.personal.address.number

Zip (Postal) Code string

The postal code of the candidate's address.

XML path: //Personal/Address/PostalCode
JSON path: $.personal.address.postalCode

City string

The city name of the candidate's address.

XML path: //Personal/Address/City
JSON path: $.personal.address.city

Subregion string, string

The subregion of the candidate's address, normalized to the ISO 3166-2 subregion classification (if application to the country).

XML path:
- //Personal/Address/SubRegionCode
- //Personal/Address/SubRegionDescription
JSON path:
- $.personal.address.subRegion.code
- $.personal.address.subRegion.description

Region / State string, string

The region of the candidate's address, normalized to the ISO 3166-2 region classification.

XML path:
- //Personal/Address/RegionCode
- //Personal/Address/RegionDescription
JSON path:
- $.personal.address.region.code
- $.personal.address.region.description

Country string, string

The country of the candidate's address, normalized to the ISO 3166-1 alpha-2 classification.

XML path:
- //Personal/Address/CountryCode
- //Personal/Address/CountryDescription
JSON path:
- $.personal.address.country.code
- $.personal.address.country.description

Telephone Numbers object[]

The phone numbers of the candidate, in the international format, including country prefix and type (home, work, mobile, or empty).

XML path:
- //Personal/Phones[]/Phone/Number (type numeric)
- //Personal/Phones[]/Phone/Type (type string)
JSON path:
- $.personal.phones[].number (type numeric)
- $.personal.phones[].type (type string)

Emails object[]

The email addresses of the candidate.

XML path: //Personal/Emails[]/Email (type string)
JSON path: $.personal.emails[].email (type string)

Personal URLs object[]

The URL to the social media profile or personal website mentioned in the document, including the type (linkedin, twitter, viadeo, xing, facebook, google_plus, github, dribbble, soundcloud, wordpress, csdn).

XML path:
- //Personal/PersonalUrls[]/PersonalUrl/Url (type string)
- //Personal/PersonalUrls[]/PersonalUrl/Type (type string)
JSON path:
- $.personal.personalUrls[].url (type string)
- $.personal.personalUrls[].type (type string)

Example JSON/XML

JSONXML

{
    "personal": {
    "title": "Drs.",
    "firstName": "Amanda",
    "middleName": "Lisa",
    "lastName": "Michaelson",
    "completeName": "Amanda Michaelson",
    "initials": "A. L.",
    "birthDate": "1980-08-06",
    "birthPlace": "Washington, DC",
    "nationality": {
        "code": "US",
        "description": "American"
    },
    "nationalId": "",
    "gender": {
        "code": "2",
        "description": "Female"
    },
    "driversLicenses" :[
        {
        "driversLicense": "B"
        }
    ], 
    "address": {
        "latitude": "33.4255104",
        "longitude": "-111.9400054",
        "addressLine": "3176 E. 14th Street",
        "street": "E. 14th Street",
        "number": "3176",
        "postalCode": "85483",
        "city": "Tempe",
        "subRegion": {
            "code": "",
            "description": ""
        },
        "region": {
            "code": "US-AZ",
            "description": "US Arizona"
        },
        "country": {
            "code": "US",
            "description": "United States"
        }
    },
    "phones": [
        {
            "number": "+1234567890",
            "type": "mobile"
        },
        {
            "number": "+1234567890",
            "type": "home"
        }
    ],
    "emails": [
        {
            "email": "amanda.michaelson@example.com"
        }
    ],
    "personalUrls": [
        {
            "url": "https:\/\/www.linkedin.com\/in\/am",
            "type": "linkedin"
        }
    ]
    }
}

<Profile>
    <Personal>
        <Title>Drs</Title>
        <FirstName>Amanda</FirstName>
        <MiddleName>Lisa</MiddleName>
        <LastName>Michaelson</LastName>
        <CompleteName>Amanda Michaelson</CompleteName>
        <Initials>A. L.</Initials>
        <BirthDate>1980-08-06</BirthDate>
        <BirthPlace>Washington, DC</BirthPlace>
        <Nationality>
            <NationalityCode>US</NationalityCode>
            <NationalityDescription>American</NationalityDescription>
        </Nationality>
        <NationalID></NationalID>
        <Gender>
            <GenderCode>2</GenderCode>
            <GenderDescription>Female</GenderDescription>
        </Gender>
        <DriversLicenses>
            <DriversLicence>B</DriversLicence>
        </DriversLicenses>
        <Address>
            <Latitude>33.4255104</Latitude>
            <Longitude>-111.9400054</Longitude>
            <AddressLine>3176 E. 14th Street</AddressLine>
            <Street>E. 14th Street</Street>
            <Number>3176</Number>
            <PostalCode>85483</PostalCode>
            <City>Tempe</City>
            <SubRegionCode></SubRegionCode>
            <SubRegionDescription></SubRegionDescription>
            <RegionCode>US-AZ</RegionCode>
            <RegionDescription>US Arizona</RegionDescription>
            <CountryCode>US</CountryCode>
            <CountryDescription>United States</CountryDescription>
        </Address>
        <Phones>
            <Phone>
                <Number>+1234567890</Number>
                <Type>mobile</Type>
            </Phone>
            <Phone>
                <Number>+1234567890</Number>
                <Type>home</Type>
            </Phone>
        </Phones>
        <Emails>
            <Email>amanda.michaelson@example.com</Email>
        </Emails>
        <PersonalUrls>
            <PersonalUrl>
                <Url>https://www.linkedin.com/in/am</Url>
                <Type>linkedin</Type>
            </PersonalUrl>
        </PersonalUrls>
    </Personal>
</Profile>

Education🔗

Degrees object[]

For each education item mentioned in the document, the following fields are returned.

The name of the degree (field DegreeName) as mentioned in the document.

The education level is returned with two different classifications:

normalized to the Textkernel Local Education Level classification (fields LocalCode and LocalDescription), based on the country of the candidate;
normalized to the Textkernel International Education Level classification (fields InternationalCode and InternationalDescription).

The following information about the institute awarding the degree:

the institute name (field Institute);
the location (field Location), as mentioned in the document;
the city (field City);
the region (field Region), this field contains US states for candidates in the US;
the code and country description (fields CountryCode and CountryDescription).

The start date of the degree (field StartDate), in the format YYYY-MM-DD.

The end date of the degree (field EndDate), in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the degree is ongoing.

A degree obtained flag indicating whether the degree has already been obtained or not (fields DiplomaCode and DiplomaDescription). Possible values are 1 if the degree was obtained, 2 if the degree was not obtained and 3 if the degree is still ongoing.

The GPA grade of the degree (field GradePointAverage). This field is only available for English documents, if mentioned in the document.

The full text of the degree (field Description).

A unique item ID for the degree item (field ItemId). This field allows to identify the source of the skills (see field FoundIn in the skills section). The ID for degree items is composed by edu_ plus the actual item index (example: edu_0).

Where not specified otherwise, the field type is string.

XML path:
- //EducationHistory/Degrees[]/Degree/DegreeName
- //EducationHistory/Degrees[]/Degree/LocalCode
- //EducationHistory/Degrees[]/Degree/LocalDescription
- //EducationHistory/Degrees[]/Degree/InternationalCode
- //EducationHistory/Degrees[]/Degree/InternationalDescription
- //EducationHistory/Degrees[]/Degree/Institute
- //EducationHistory/Degrees[]/Degree/Location
- //EducationHistory/Degrees[]/Degree/City
- //EducationHistory/Degrees[]/Degree/Region
- //EducationHistory/Degrees[]/Degree/CountryCode
- //EducationHistory/Degrees[]/Degree/CountryDescription
- //EducationHistory/Degrees[]/Degree/StartDate (type date)
- //EducationHistory/Degrees[]/Degree/EndDate (type date)
- //EducationHistory/Degrees[]/Degree/DiplomaCode (type numeric)
- //EducationHistory/Degrees[]/Degree/DiplomaDescription
- //EducationHistory/Degrees[]/Degree/GradePointAverage (type float)
- //EducationHistory/Degrees[]/Degree/Description
- //EducationHistory/Degrees[]/Degree/ItemId
JSON path:
- $.educationHistory.degrees[].degreeName
- $.educationHistory.degrees[].localCode
- $.educationHistory.degrees[].localDescription
- $.educationHistory.degrees[].internationalCode
- $.educationHistory.degrees[].internationalDescription
- $.educationHistory.degrees[].institute
- $.educationHistory.degrees[].location
- $.educationHistory.degrees[].city
- $.educationHistory.degrees[].region
- $.educationHistory.degrees[].country.code
- $.educationHistory.degrees[].country.description
- $.educationHistory.degrees[].startDate (type date)
- $.educationHistory.degrees[].endDate (type date)
- $.educationHistory.degrees[].diplomaCode (type numeric)
- $.educationHistory.degrees[].diplomaDescription
- $.educationHistory.degrees[].gradePointAverage (type float)
- $.educationHistory.degrees[].description
- $.educationHistory.degrees[].itemId

Courses object[]

For each course mentioned in the document, the following fields are returned.

The name of the course (field CourseName) as mentioned in the document.

The following information about the institute helding the course:

the institute name (field Institute);
the location (field Location), as mentioned in the document;
the city (field City);
the region (field Region), this field contains US states for candidates in the US;
the country code and country description (fields CountryCode and CountryDescription).

The start date of the course (field StartDate), in the format YYYY-MM-DD.

The end date of the course (field EndDate), in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the course is ongoing.

The full text of the course (field Description).

A unique item ID for the course (field ItemId). This field allows to identify the source of the skills (see field FoundIn in the skills section). The ID for courses is composed by 'edu_' plus the actual item index (example: edu_0).

Where not specified otherwise, the field type is string.

XML path:
- //EducationHistory/Courses[]/Course/CourseName
- //EducationHistory/Courses[]/Course/Institute
- //EducationHistory/Courses[]/Course/Location
- //EducationHistory/Courses[]/Course/City
- //EducationHistory/Courses[]/Course/Region
- //EducationHistory/Courses[]/Course/CountryCode
- //EducationHistory/Courses[]/Course/CountryDescription
- //EducationHistory/Courses[]/Course/StartDate (type date)
- //EducationHistory/Courses[]/Course/EndDate (type date)
- //EducationHistory/Courses[]/Course/Description
- //EducationHistory/Courses[]/Course/ItemId
JSON path:
- $.educationHistory.courses[].courseName
- $.educationHistory.courses[].institute
- $.educationHistory.courses[].location
- $.educationHistory.courses[].city
- $.educationHistory.courses[].region
- $.educationHistory.courses[].country.code
- $.educationHistory.courses[].country.description
- $.educationHistory.courses[].startDate (type date)
- $.educationHistory.courses[].endDate (type date)
- $.educationHistory.courses[].description
- $.educationHistory.courses[].itemId

Education Section string

The extracted text containing the education information from the document.

XML path: //EducationHistory/EducationSection
JSON path: $.educationHistory.educationSection

Example JSON/XML

JSONXML

{
    "educationHistory": {
        "degrees": [
            {
                "degreeName": "specialized in Commerce",
                "localCode": "US_8",
                "localDescription": "High School",
                "internationalCode": "1",
                "internationalDescription": "Secondary Education",
                "institute": "Mesa High School",
                "location": "Mesa",
                "city": "Mesa",
                "region": "AZ",
                "country": {
                    "code": "US",
                    "description": "United States"
                },
                "startDate": "1992-09-01",
                "endDate": "1996-06-30",
                "diplomaCode": "1",
                "diplomaDescription": "Yes",
                "gradePointAverage": "4.3",
                "description": "1992-1996 Mesa High School, specialized in Commere Grade Point Average: 4.3"
                "itemId": "edu_0"
        ],
        "courses": [
            {
                "courseName": "Marketing basic course",
                "institute": "Darlington Employment Services",
                "location": "Darlington",
                "city": "Darlington",
                "region": "SC",
                "country": {
                    "code": "US",
                    "description": "United States"
                },
                "startDate": "1997-09-01",
                "endDate": "1997-10-29",
                "description": "Marketing basic course at Darlington Employment Services, Darlington SC. 1997-09-01 - 1997-10-29."
                "itemId": "edu_2"
            }
        ],
        "educationSection": "..."
    }
}

<Profile>
    <EducationHistory>
        <Degrees>
            <Degree>
                <DegreeName>specialized in Commere</DegreeName>
                <LocalCode>US_8</LocalCode>
                <LocalDescription>High School</LocalDescription>
                <InternationalCode>1</InternationalCode>
                <InternationalDescription>Secondary Education</InternationalDescription>
                <Institute>Mesa High School</Institute>
                <Location>Mesa</Location>
                <City>Mesa</City>
                <Region>AZ</Region>
                <CountryCode>US</CountryCode>
                <CountryDescription>United States</CountryDescription>
                <StartDate>1992-09-01</StartDate>
                <EndDate>1996-06-30</EndDate>
                <DiplomaCode>1</DiplomaCode>
                <DiplomaDescription>Yes</DiplomaDescription>
                <GradePointAverage>4.3</GradePointAverage>
                <Description>1992-1996 Mesa High School, specialized in Commere Grade Point Average: 4.3</Description>
                <ItemId>edu_0</ItemId>
            </Degree>
        </Degrees>
        <Courses>
            <Course>
                <CourseName>Marketing basic course</CourseName>
                <Institute>Darlington Employment Services</Institute>
                <Location>Darlington</Location>
                <City>Darlington</City>
                <Region>SC</Region>
                <CountryCode>US</CountryCode>
                <CountryDescription>United States</CountryDescription>
                <StartDate>1997-09-01</StartDate>
                <EndDate>1997-10-29</EndDate>
                <Description>Marketing basic course at Darlington Employment Services, Darlington SC. 1997-09-01 - 1997-10-29.</Description>
                <ItemId>edu_2</ItemId>
            </Course>
        </Courses>
        <EducationSection>...</EducationSection>
    </EducationHistory>
</Profile>

Work History🔗

Experiences object[] Add-on required for some fields

For each experience item mentioned in the document, the following fields are returned.

The job title of the position held by the candidate (field Job Title), as mentioned in the document.

The following information about the employer:

the employer name (field EmployerName);
the location (field Location);
the city (field City);
the region (field Region), this field contains US states for candidates in the US;
the country code and country description (fields CountryCode and CountryDescription).

The start date of the degree (field StartDate), in the format YYYY-MM-DD.

The end date of the degree (field EndDate), in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the degree is ongoing.

The experience in years (field Years) and experience in months (field Months), calculated based on the start and end date.

A latest experience flag (field IsLatestExperience) indicating whether the experience item is the most recent experience in the document (value 1) or not (value 0).

An ongoing experience flag (field IsCurrentExperience) indicating whether the experience item is still ongoing as per the document (value 1) or it already concluded (value 0).

The description of the position (field Description).

A unique item ID for the experience item (field ItemId). This field allows to identify the source of the skills (see field FoundIn in the skills section). The ID for experience items is composed by exp_ plus the actual item index (example: exp_0).

Additionally, based on the job title field, the following fields are returned (Note: These fields require the Professions Classification add-on):

the Textkernel Profession (fields ProfessionCode and ProfessionDescription);
the Textkernel Profession Group (fields ProfessionGroup and ProfessionGroupDescription);
the Textkernel Profession Class (fields ProfessionClass and ProfessionClassDescription);
the ONET2010 Profession (fields ONET2010Code and ONET2010Description), please note this classification is deprecated in favor of ONET2019, and will be removed in September 2024;
the ONET2019 Profession (field ONET2019Code);
the ISCO2008 Profession (fields ISCO2008Code and ISCO2008Description);

Where not specified otherwise, the field type is string.

XML path:
- //EmploymentHistory[]/Experience/JobTitle
- //EmploymentHistory[]/Experience/Organization
- //EmploymentHistory[]/Experience/Location
- //EmploymentHistory[]/Experience/City
- //EmploymentHistory[]/Experience/Region
- //EmploymentHistory[]/Experience/CountryCode
- //EmploymentHistory[]/Experience/CountryDescription
- //EmploymentHistory[]/Experience/ProfessionCode This field requires an additional add-on
- //EmploymentHistory[]/Experience/ProfessionDescription This field requires an additional add-on
- //EmploymentHistory[]/Experience/ProfessionGroupCode This field requires an additional add-on
- //EmploymentHistory[]/Experience/ProfessionGroupDescription This field requires an additional add-on
- //EmploymentHistory[]/Experience/ProfessionClassCode This field requires an additional add-on
- //EmploymentHistory[]/Experience/ProfessionClassDescription This field requires an additional add-on
- //EmploymentHistory[]/Experience/ONET2010Code This field requires an additional add-on
- //EmploymentHistory[]/Experience/ONET2010Description This field requires an additional add-on
- //EmploymentHistory[]/Experience/ONET2019Code This field requires an additional add-on
- //EmploymentHistory[]/Experience/ISCO2008Code This field requires an additional add-on
- //EmploymentHistory[]/Experience/ISCO2008Description This field requires an additional add-on
- //EmploymentHistory[]/Experience/StartDate (type date)
- //EmploymentHistory[]/Experience/EndDate (type date)
- //EmploymentHistory[]/Experience/Years (type numeric)
- //EmploymentHistory[]/Experience/Months (type numeric)
- //EmploymentHistory[]/Experience/IsLatestExperience (type numeric)
- //EmploymentHistory[]/Experience/IsCurrentExperience (type numeric)
- //EmploymentHistory[]/Experience/Description
- //EmploymentHistory[]/Experience/ItemId
JSON path:
- $.employmentHistory[].jobTitle
- $.employmentHistory[].organization
- $.employmentHistory[].location
- $.employmentHistory[].city
- $.employmentHistory[].region
- $.employmentHistory[].country.code
- $.employmentHistory[].country.description
- $.employmentHistory[].professionCode This field requires an additional add-on
- $.employmentHistory[].professionDescription This field requires an additional add-on
- $.employmentHistory[].professionGroupCode This field requires an additional add-on
- $.employmentHistory[].professionGroupDescription This field requires an additional add-on
- $.employmentHistory[].professionClassCode This field requires an additional add-on
- $.employmentHistory[].professionClassDescription This field requires an additional add-on
- $.employmentHistory[].oNET2010Code This field requires an additional add-on
- $.employmentHistory[].oNET2010Desciption This field requires an additional add-on
- $.employmentHistory[].oNET2019Code This field requires an additional add-on
- $.employmentHistory[].iSCO2008Code This field requires an additional add-on
- $.employmentHistory[].iSCO2008Description This field requires an additional add-on
- $.employmentHistory[].startDate (type date)
- $.employmentHistory[].endDate (type date)
- $.employmentHistory[].years (type numeric)
- $.employmentHistory[].months (type numeric)
- $.employmentHistory[].isLatestExperience (type numeric)
- $.employmentHistory[].isCurrentExperience (type numeric)
- $.employmentHistory[].description
- $.employmentHistory[].itemId

Example JSON/XML

JSONXML

{
    "employmentHistory": [
        {
            "jobTitle": "Senior Credit Analyst",
            "organization": "Acme Corp.",
            "location": "New York",
            "city": "New York",
            "region": "NY",
            "country": {
                "code": "US",
                "description": "United States"
            },
            "professionCode": "1981",
            "professionDescription": "Credit Analyst",
            "professionGroupCode": "254",
            "professionGroupDescription": "Financial Experts",
            "professionClassCode": "24",
            "professionClassDescription": "Insurance and Finance",
            "oNET2010Code": "13_2041_00",
            "oNET2010Description": "Credit Analysts",
            "oNET2019Code": "13-2041.00",
            "iSCO2008Code": "3312",
            "iSCO2008Description": "Credit and loans officers",
            "startDate": "2002-03-01",
            "endDate": "__NOWSTRING__",
            "years": "22",
            "months": "258",
            "is_latest_experience": "1",
            "is_current_experience": "1",
            "description": "*Position involves working closely with...",
            "itemId": "exp_0"
        }
    ]
}

<Profile>
    <EmploymentHistory>
        <Experience>
            <JobTitle>Senior Credit Analyst</JobTitle>
            <Organization>Acme Corp.</Organization>
            <Location>New York</Location>
            <City>New York</City>
            <Region>NY</Region>
            <CountryCode>US</CountryCode>
            <CountryDescription>United States</CountryDescription>
            <ProfessionCode>1981</ProfessionCode>
            <ProfessionDescription>Credit Analyst</ProfessionDescription>
            <ProfessionGroupCode>254</ProfessionGroupCode>
            <ProfessionGroupDescription>Financial Experts</ProfessionGroupDescription>
            <ProfessionClassCode>24</ProfessionClassCode>
            <ProfessionClassDescription>Insurance and Finance</ProfessionClassDescription>
            <ONET2010Code>13_2041_00</ONET2010Code>
            <ONET2010Description>Credit Analysts</ONET2010Description>
            <ONET2019Code>13-2041.00</ONET2019Code>
            <ISCO2008Code>3312</ISCO2008Code>
            <ISCO2008Description>Credit and loans officers</ISCO2008Description>
            <StartDate>2002-03-01</StartDate>
            <EndDate>__NOWSTRING__</EndDate>
            <Years>22</Years>
            <Months>258</Months>
            <IsLatestExperience>1</IsLatestExperience>
            <IsCurrentExperience>1</IsCurrentExperience>
            <Description>
                *Position involves working closely with...
            </Description>
            <ItemId>exp_0</ItemId>
        </Experience>
    </EmploymentHistory>
</Profile>

Skills🔗

IT Skills object[] Add-on required for some fields

The list of IT skills owned by the candidate, as extracted from the document (field Skill). Each skill node also contains the following data (if extracted):

its level (field Level);
the years of experience in the skill (field Years);
the date the skill was last used (field LastUsed), inferred from the work history, in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the skill is used in the current ongoing job held by the candidate;
a comma-separated list of Work History items Id's indicating where the skill was found (field FoundIn).

Additionally, the list of the extracted IT skills normalized to the Textkernel Skills Taxonomy (fields SkillCode and SkillDescription). Note: These fields require the Skills Classification add-on.

Where not specified otherwise, the field type is string.

XML path:
- //Skills/ComputerSkills[]/ComputerSkill/Skill
- //Skills/ComputerSkills[]/ComputerSkill/Level
- //Skills/ComputerSkills[]/ComputerSkill/SkillCode This field requires an additional add-on
- //Skills/ComputerSkills[]/ComputerSkill/SkillDescription This field requires an additional add-on
- //Skills/ComputerSkills[]/ComputerSkill/Years (type numeric)
- //Skills/ComputerSkills[]/ComputerSkill/LastUsed (type date)
- //Skills/ComputerSkills[]/ComputerSkill/FoundIn
JSON path:
- $.skills.computerSkills[].skill
- $.skills.computerSkills[].level
- $.skills.computerSkills[].skillCode This field requires an additional add-on
- $.skills.computerSkills[].skillDescription This field requires an additional add-on
- $.skills.computerSkills[].years (type numeric)
- $.skills.computerSkills[].lastUsed (type date)
- $.skills.computerSkills[].foundIn

Language Skills object[] Add-on required for some fields

The list of language skills owned by the candidate, normalized to the ISO 639-1 classification (fields SkillCode and SkillDescription). As opposed to the other skill types, normalized values for language skills do not require an add-on.

Each skill node also contains the following data (if extracted):

the language proficiency normalized to the Textkernel Language Skill Level classification (field LevelCode and LevelDescription);
the years of experience in the skill (field Years);
the date the skill was last used (field LastUsed), inferred from the work history, in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the skill is used in the current ongoing job held by the candidate;
a comma-separated list of Work History items Id's indicating where the skill was found (field FoundIn).

Where not specified otherwise, the field type is string.

XML path:
- //Skills/LanguageSkills[]/LanguageSkill/SkillCode
- //Skills/LanguageSkills[]/LanguageSkill/SkillDescription
- //Skills/LanguageSkills[]/LanguageSkill/LevelCode
- //Skills/LanguageSkills[]/LanguageSkill/LevelDescription
- //Skills/LanguageSkills[]/LanguageSkill/Years (type numeric)
- //Skills/LanguageSkills[]/LanguageSkill/LastUsed (type date)
- //Skills/LanguageSkills[]/LanguageSkill/FoundIn
JSON path:
- $.skills.languageSkills[].skillCode
- $.skills.languageSkills[].skillDescription
- $.skills.languageSkills[].levelCode
- $.skills.languageSkills[].levelDescription
- $.skills.languageSkills[].years (type numeric)
- $.skills.languageSkills[].lastUsed (type date)
- $.skills.languageSkills[].foundIn

Soft Skills object[] Add-on required for some fields

The list of soft skills owned by the candidate, as extracted from the document (field Skill). Each skill node also contains the following data (if extracted):

its level (field Level);
the years of experience in the skill (field Years);
the date the skill was last used (field LastUsed), inferred from the work history, in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the skill is used in the current ongoing job held by the candidate;
a comma-separated list of Work History items Id's indicating where the skill was found (field FoundIn).

Additionally, the list of the extracted soft skills normalized to the Textkernel Skills Taxonomy (fields SkillCode and SkillDescription). Note: These fields require the Skills Classification add-on.

Where not specified otherwise, the field type is string.

XML path:
- //Skills/SoftSkills[]/ComputerSkill/Skill
- //Skills/SoftSkills[]/ComputerSkill/Level
- //Skills/SoftSkills[]/ComputerSkill/SkillCode This field requires an additional add-on
- //Skills/SoftSkills[]/ComputerSkill/SkillDescription This field requires an additional add-on
- //Skills/SoftSkills[]/ComputerSkill/Years (type numeric)
- //Skills/SoftSkills[]/ComputerSkill/LastUsed (type date)
- //Skills/SoftSkills[]/ComputerSkill/FoundIn
JSON path:
- $.skills.softSkills[].skill
- $.skills.softSkills[].level
- $.skills.softSkills[].skillCode This field requires an additional add-on
- $.skills.softSkills[].skillDescription This field requires an additional add-on
- $.skills.softSkills[].years (type numeric)
- $.skills.softSkills[].lastUsed (type date)
- $.skills.softSkills[].foundIn

Professional Skills object[] Add-on required for some fields

The list of professional skills owned by the candidate, as extracted from the document (field Skill). Each skill node also contains the following data (if extracted):

its level (field Level);
the years of experience in the skill (field Years);
the date the skill was last used (field LastUsed), inferred from the work history, in the format YYYY-MM-DD or the placeholder __NOWSTRING__ if the skill is used in the current ongoing job held by the candidate;
a comma-separated list of Work History items Id's indicating where the skill was found (field FoundIn).

Additionally, the list of the extracted professional skills normalized to the Textkernel Skills Taxonomy (fields SkillCode and SkillDescription). Note: These fields require the Skills Classification add-on.

Where not specified otherwise, the field type is string.

XML path:
- //Skills/OtherSkills[]/ComputerSkill/Skill
- //Skills/OtherSkills[]/ComputerSkill/Level
- //Skills/OtherSkills[]/ComputerSkill/SkillCode This field requires an additional add-on
- //Skills/OtherSkills[]/ComputerSkill/SkillDescription This field requires an additional add-on
- //Skills/OtherSkills[]/ComputerSkill/Years (type numeric)
- //Skills/OtherSkills[]/ComputerSkill/LastUsed (type date)
- //Skills/OtherSkills[]/ComputerSkill/FoundIn
JSON path:
- $.skills.otherSkills[].skill
- $.skills.otherSkills[].level
- $.skills.otherSkills[].skillCode This field requires an additional add-on
- $.skills.otherSkills[].skillDescription This field requires an additional add-on
- $.skills.otherSkills[].years (type numeric)
- $.skills.otherSkills[].lastUsed (type date)
- $.skills.otherSkills[].foundIn

Example JSON/XML

JSONXML

{
    "skills": {
        "computerSkills": [
            {
                "skill": "Excel",
                "skillCode": "KS1200H6XYN1CR0G5NZ0",
                "skillDescription": "Microsoft Excel",
                "level": "",
                "years": "",
                "last_used": "",
                "foundIn": "exp_3, edu_2"
            }
        ],
        "languageSkills": [
            {
                "skillCode": "en",
                "skillDescription": "English",
                "levelCode": "6",
                "levelDescription": "Native",
                "years": "",
                "last_used": "",
                "foundIn": ""
            }
        ],
        "softSkills": [
            {
                "skill": "ability to adapt",
                "skillCode": "KS120626HMWCXJWJC7VK",
                "skillDescription": "Adaptability",
                "level": "",
                "years": "",
                "last_used": "",
                "foundIn": "exp_3, jt_2, edu_1"
                }
        ],
        "otherSkills": [
            {
                "skill": "Clerical duties",
                "skillCode": "KS7G7FY6ZT1MQXD1KTDY",
                "skillDescription": "Administrative Operations",
                "level": "",
                "years": "4",
                "last_used": "2000-03-01",
                "foundIn": "exp_3, jt_3, edu_1"
                }
        ]
    }
}

<Profile>
    <Skills>
        <ComputerSkills>
            <ComputerSkill>
                <Skill>Excel</Skill>
                <SkillCode>KS1200H6XYN1CR0G5NZ0</SkillCode>
                <SkillDescription>Microsoft Excel</SkillDescription>
                <Level></Level>
                <Years></Years>
                <LastUsed></LastUsed>
                <FoundIn>exp_3, edu_2</FoundIn>
            </ComputerSkill>
        </ComputerSkills>
        <LanguageSkills>
            <LanguageSkill>
                <SkillCode>en</SkillCode>
                <SkillDescription>English</SkillDescription>
                <LevelCode>6</LevelCode>
                <LevelDescription>Native</LevelDescription>
                <Years></Years>
                <LastUsed></LastUsed>
                <FoundIn></FoundIn>
            </LanguageSkill>
        </LanguageSkills>
        <SoftSkills>
            <SoftSkill>
                <Skill>ability to adapt</Skill>
                <SkillCode>KS120626HMWCXJWJC7VK</SkillCode>
                <SkillDescription>Adaptability</SkillDescription>
                <Level></Level>
                <Years></Years>
                <LastUsed></LastUsed>
                <FoundIn>exp_3, jt_2, edu_1</FoundIn>
            </SoftSkill>
        </SoftSkills>
        <OtherSkills>
            <OtherSkill>
                <Skill>Clerical duties</Skill>
                <SkillCode>KS7G7FY6ZT1MQXD1KTDY</SkillCode>
                <SkillDescription>Administrative Operations</SkillDescription>
                <Level></Level>
                <Years>4/Years>
                <LastUsed>2000-03-01</LastUsed>
                <FoundIn>exp_3, jt_3, edu_1</FoundIn>
            </OtherSkill>
        </OtherSkills>
    </Skills>
</Profile>

Additional Information🔗

Hobby object[]

The list of hobbies mentioned the document.

XML path: //Other/Hobbies[]/Hobby (type string)
JSON path: $.other.hobbies[].hobby (type string)

Profile Picture data, string, string

Returns base64 encoding of the picture, its filename and content type

XML path:
- //Other/ProfilePicture/Base64Content
- //Other/ProfilePicture/Filename
- //Other/ProfilePicture/ContentType
JSON path:
- $.other.profilePicture.base64Content
- $.other.profilePicture.filename
- $.other.profilePicture.contentType

Document Text Representation string

The plain text representation of the document.

XML path: //DocumentText
JSON path: $.documentText

Document HTML Representation string

The HTML representation of the document.

XML path: //DocumentHTML
JSON path: $.documentHtml

Example JSON/XML

JSONXML

{
    "other": {
        "hobbies": [
            {
            "hobby": "Reading"
            }
        ],
        "profilePicture": {
            "base64Content": "4AAQSkZJRgABAQAAAQAB...",
            "filename": "6.jpg",
            "contentType": "image\/jpeg"
        }
    },
    "documentText": "...",
    "documentHtml": "..."
}

<Profile>
    <Other>
        <Hobbies>
            <Hobby>Gardening</Hobby>
            <Hobby>reading</Hobby>
            <Hobby>cabaret shows</Hobby>
        </Hobbies>
        <ProfilePicture>
            <Base64Content>....</Base64Content>
            <Filename>6.jpg</Filename>
            <ContentType>image/jpeg</ContentType>
        </ProfilePicture>
    </Other>
    <DocumentText>...</DocumentText>
    <DocumentHtml>...</DocumentHtml>
</Profile>