Sovren | REST API

Sovren REST API

This documentation is for Version 10 of the Sovren REST API, released on December 15, 2020. Both V9 and V10 use the same parsing and matching engines under-the-hood, but V10 is more streamlined and has a vastly simpler output. Please visit this link for an in-depth comparison.

First Steps

This documentation is for technical details about the API only. Before starting your integration, you should read the Product Documentation for the products you plan to integrate with. We will show you the most important information on how to create a quick and successful integration.
Then, read the Acceptable Use Policy. There are many items in the Acceptable Use Policy that will require your programming expertise in order to be in compliance. Sovren's products and services contain open source software developed by third parties. A list of this software, including licensing and links to source code, can be found in our Open Source Disclosure.
If programming in Java or C#, install the Sovren SDK using the links in the section below. Otherwise, review the code samples and endpoint documentation throughout the rest of this page.

Sovren SDK

The easiest and fastest way to get started programming your integration to the Version 10 API is by using our SDKs. We currently offer SDKs in C# and Java, with others to follow. This is, by far, the best way to use our software. You can parse a document with as little as 3 lines of code!

Each GitHub link below has installation instructions, documentation, and many code examples to help get you started. The SDKs can also be found directly using your preferred package manager.

Programming Language	GitHub
C#	https://github.com/sovren/sovren-dotnet
Java	https://github.com/sovren/sovren-java

Code Samples

Here we have a few code samples to get you up and running quickly:

//this code uses the official SDK (see https://github.com/sovren/sovren-dotnet)
SovrenClient client = new SovrenClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
    
//A Document is an unparsed File (PDF, Word Doc, etc)
Document doc = new Document("resume.docx");

//when you create a ParseRequest, you can specify many configuration settings
//in the ParseOptions. See http://docs.sovren.com/API/Rest#parse-resume
ParseRequest request = new ParseRequest(doc, new ParseOptions());

try
{
    ParseResumeResponse response = await client.ParseResume(request);
    //if we get here, it was 200-OK and all operations succeeded

    //now we can use the response from Sovren to ouput some of the data from the resume
    Console.WriteLine("Name: " + response.EasyAccess().GetCandidateName()?.FormattedName);
    Console.WriteLine("Email: " + response.EasyAccess().GetEmailAddresses()?.FirstOrDefault());
    Console.WriteLine("Phone: " + response.EasyAccess().GetPhoneNumbers()?.FirstOrDefault());
}
catch (SovrenException e)
{
    //this was an outright failure, always try/catch for SovrenExceptions when using the SovrenClient
    Console.WriteLine($"Error: {e.SovrenErrorCode}, Message: {e.Message}");
}

//https://developer.mozilla.org/en-US/docs/Using_files_from_web_applications
var file = $("#input").files[0];
var modifiedDate = (new Date(file.lastModified)).toISOString().substring(0, 10);
var reader = new FileReader();

reader.onload = function (event) {
    //the Base64 library can be found at http://docs.sovren.com/Downloads/v10/Libs/base64.zip
    var base64Text = Base64.encodeArray(event.target.result);

    var data = {
        "DocumentAsBase64String": base64Text,
        "DocumentLastModified": modifiedDate
        //other options here (see http://docs.sovren.com/API/Rest/Parsing)
    };

            //use https://eu-rest.resumeparsing.com/v10/parser/resume if your account is in the EU data center
    //NOTE: this is shown for demonstration purposes only, you should never embed your credentials
    // in javascript that is going to be distributed to end users. Instead, your javascript should
    // call a back-end service which then makes the POST to Sovren's API
    $.ajax({
        "url": "https://rest.resumeparsing.com/v10/parser/resume",
        "method": "POST",
        "crossDomain": true,
        "headers": {
            "Accept": "application/json",
            "Content-Type": "application/json",
            "Sovren-AccountId": "12345678",
            "Sovren-ServiceKey": "eumey7feY5zjeWZW397Jks6PBj2NRKSH"
        },
        "data": JSON.stringify(data)
    });
}

// when the file is read it triggers the onload event above.
reader.readAsArrayBuffer(file);

import base64
import requests #this module will need to be installed
import json
import os.path
import datetime

base64str = ''
filePath = 'resume.docx'
#open the file, encode the bytes to base64, then decode that to a UTF-8 string
with open(filePath, 'rb') as f:
    base64str = base64.b64encode(f.read()).decode('UTF-8')

epochSeconds = os.path.getmtime(filePath)
lastModifiedDate = datetime.datetime.fromtimestamp(epochSeconds).strftime("%Y-%m-%d") 

#use https://eu-rest.resumeparsing.com/v10/parser/resume if your account is in the EU data center
url = "https://rest.resumeparsing.com/v10/parser/resume"
payload = {
    'DocumentAsBase64String': base64str,
    'DocumentLastModified': lastModifiedDate
    #other options here (see http://docs.sovren.com/API/Rest/Parsing)
}

headers = {
    'accept': "application/json",
    'content-type': "application/json",
    'sovren-accountid': "12345678",
    'sovren-servicekey': "eumey7feY5zjeWZW397Jks6PBj2NRKSH",
}

#make the request, NOTE: the payload must be serialized to a json string
response = requests.request("POST", url, data=json.dumps(payload), headers=headers)
responseJson = json.loads(response.content)

#grab the ResumeData
resumeData = responseJson['Value']['ResumeData']

#access the ResumeData properties with simple JSON syntax:
print(resumeData['ContactInformation']['CandidateName']['FormattedName'])
#for response properties and types, see http://docs.sovren.com/API/Rest/Parsing

require 'uri'
require 'net/http'
require 'net/https'
require 'base64'
require 'json'

file_path = 'resume.docx'
file_data = IO.binread(file_path)
modified_date = File.mtime(file_path).to_s[0,10]

# Encode the bytes to base64
base_64_file = Base64.encode64(file_data)
data = {
  "DocumentAsBase64String" => base_64_file,
  "DocumentLastModified" => modified_date
   #other options here (see http://docs.sovren.com/API/Rest/Parsing)
}.to_json


#use https://eu-rest.resumeparsing.com/v10/parser/resume if your account is in the EU data center

uri = URI.parse("https://rest.resumeparsing.com/v10/parser/resume")
https = Net::HTTP.new(uri.host,uri.port)
https.use_ssl = true

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Sovren-AccountId' => '12345678', # use your account id here
  'Sovren-ServiceKey' =>  'eumey7feY5zjeWZW397Jks6PBj2NRKSH', # use your service key here
}

req = Net::HTTP::Post.new(uri.path, initheader = headers)
req.body = data

res = https.request(req)

# Parse the response body into an object
respObj = JSON.parse(res.body)

# Access properties such as the GivenName and PlainText
givenName = respObj["Value"]["ResumeData"]["ContactInformation"]["CandidateName"]["GivenName"]
resumeText = respObj["Value"]["ResumeData"]["ResumeMetadata"]["PlainText"]

//this code uses the official SDK (see https://github.com/sovren/sovren-java)
SovrenClient client = new SovrenClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US);
    
//A Document is an unparsed File (PDF, Word Doc, etc)
Document doc = new Document("resume.docx");

//when you create a ParseRequest, you can specify many configuration settings
//in the ParseOptions. See http://docs.sovren.com/API/Rest#parse-resume
ParseRequest request = new ParseRequest(doc, new ParseOptions());

try {
    ParseResumeResponse response = client.parseResume(request);
    //if we get here, it was 200-OK and all operations succeeded

    //now we can use the response from Sovren to ouput some of the data from the resume
    System.out.println("Name: " + response.Value.ResumeData.ContactInformation.CandidateName.FormattedName);
    System.out.println("Experience: " + response.Value.ResumeData.EmploymentHistory.ExperienceSummary.Description);
}
catch (SovrenException e) {
    //this was an outright failure, always try/catch for SovrenExceptions when using the SovrenClient
    System.out.println("Error: " + e.SovrenErrorCode + ", Message: " + e.getMessage());
}

//If your PHP installation doesn't have an up-to-date CA root certificate bundle, download the one at the curl website and save it on your server:
//http://curl.haxx.se/docs/caextract.html
//Then set a path to it in your php.ini file, e.g. on Windows:
//curl.cainfo=c:\php\cacert.pem
        
// open the file
$filepath = "resume.docx";
$handle = fopen($filepath, "r");
$contents = fread($handle, filesize($filepath));
fclose($handle);

$modifiedDate = date("Y-m-d", filemtime($filepath));

//encode to base64
$base64str = base64_encode($contents);
$data = ["DocumentAsBase64String" => $base64str, "DocumentLastModified" => $modifiedDate];
//other options here (see http://docs.sovren.com/API/Rest/Parsing)

//use https://eu-rest.resumeparsing.com/v10/parser/resume if your account is in the EU data center
$url = "https://rest.resumeparsing.com/v10/parser/resume";
        
//setup curl to make the REST call, you can use an external library
//such as Guzzle if you prefer: http://guzzle.readthedocs.io
$curl = curl_init();
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));
        
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        
$headers = [
    "accept: application/json",
    "content-type: application/json; charset=utf-8",
    "sovren-accountid: 12345678",
    "sovren-servicekey: eumey7feY5zjeWZW397Jks6PBj2NRKSH"
];
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
        
$result = curl_exec($curl);
curl_close($curl);

//$result now has the parsed document, you can now use json_decode if you like to use Value.ResumeData
//for response properties and types, see http://docs.sovren.com/API/Rest/Parsing

const http = require('https');
const fs = require('fs');

var filePath = "resume.docx";
var buffer = fs.readFileSync(filePath);
var base64Doc = buffer.toString('base64');

var modifiedDate = (new Date(fs.statSync(filePath).mtimeMs)).toISOString().substring(0, 10);

//other options here (see http://docs.sovren.com/API/Rest/Parsing)
var postData = JSON.stringify({
    'DocumentAsBase64String': base64Doc,
    'DocumentLastModified': modifiedDate
});

//use https://eu-rest.resumeparsing.com/v10/parser/resume if your account is in the EU data center
var options = {
    host: 'rest.resumeparsing.com',
    protocol: 'https:',
    path: '/v10/parser/resume',
    method: 'POST',
    headers: {
        'Sovren-AccountId': '12345678',
        'Sovren-ServiceKey': 'eumey7feY5zjeWZW397Jks6PBj2NRKSH',
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Content-Length': postData.length
  }
};

var request = http.request(options, function (response) {
    console.log(`STATUS: ${response.statusCode}`);
    response.setEncoding('utf8');
    
    var responseAsString = '';
    
    response.on('data', (chunk) => {
        responseAsString += chunk;
    });
    
    response.on('end', () => {
        var responseAsJson = JSON.parse(responseAsString);
        console.log(responseAsJson.Info);
        
        var resumeData = responseAsJson.Value.ResumeData;        
        	
        //now you can consume the resumeData
    });
});

request.write(postData);
request.end();

All above code samples are provided without warranty and are not necessarily indicative of best practices.

Standard Transaction Cost

Endpoint	Cost
POST /v10/parser/*	1 credit (2 credits with matching enabled, additional credits can be consumed when geocoding is enabled that follow the same structure as the `POST /geocoder/*` endpoint)
POST /v10/scorer/bimetric	1 credit + number of target documents * 0.1
POST /v10/matcher/*	Free when initiated by a human end-user for a single transaction. (Additional credits can be consumed when geocoding is enabled that follow the same structure as the `POST /geocoder/*` endpoint). When this method is called by anything other than a human end-user, this endpoint may be subject to an additional 1 credit surcharge as per the Acceptable Use Policy.
POST /v10/searcher	Free when initiated by a human end-user for a single transaction. (Additional credits can be consumed when geocoding is enabled that follow the same structure as the `POST /geocoder/*` endpoint). When this method is called by anything other than a human end-user, this endpoint may be subject to an additional 1 credit surcharge as per the Acceptable Use Policy.
POST /v10/geocoder/*	1 credit if using the default options. 0.1 credits if you specify your own provider key. If you use geocoding in parsing/searching/matching the same cost is applied to those transactions.
POST /v10/geocodeAndIndex/*	1 credit if using the default options. 0.1 credits if you specify you own provider key. 0 credits (free) if you specify the latitude/longitude.
GET /v10/index/{indexId}/count	1 credit. There should never be a need to call this endpoint. You control when documents are added/deleted from your indexes, so you should always know how many documents are in any given index.
GET /v10/index	10 credits. There should never be a need to call this endpoint. You should be keeping track of what indexes you have created and deleted. Adding a document to an index that doesn't exist will return a `404 - Not Found` error.
GET /v10/account	1 credit. You should only call this endpoint if you are batch parsing, and you should only call it in compliance with our Acceptable Use Policy.

Note: Credit cost is increased 15% when Sovren Sourcing is enabled.

Note: Additional costs may be incurred when using deprecated versions as per the Terms of Service.

Endpoints

Notes

Our REST API is also documented using Swagger. Follow the links below for the appropriate data center to access an HTML page where you can make sample requests.

	US Data Center	EU Data Center
HTTPS	https://rest.resumeparsing.com/v10/	https://eu-rest.resumeparsing.com/v10/

Authentication

Our REST API handles authentication via the Sovren-AccountId and Sovren-ServiceKey headers. These keys were generated during account creation and send to the contacts listed on the account. If authentication fails we return a 401 Unathorized HTTP Status Code.

The most common causes for unauthorized exceptions are:

Not including the headers in the request
Making requests to the wrong data center. If you have questions about which data center your account is setup for contact support@sovren.com

If you recieve a 403 Forbidden Access exception, please confirm that you are using https. We have deprecated the use of unsecured http connections in this verison.

Versioning

We continuously deploy bug fixes and new features to our API. We limit breaking changes to new versions deployed to new urls unless the change is to fix an error in the output. In the top-left of our documentation site you can change the API version of the documentation.

Release notes can be found here.

When integrating to our API, make sure that all of your API calls use same version. When upgrading to a new version it's crucial to upgrade all api calls to the new version at the same time. NEVER use multiple versions in your integration.

There are four different statuses for API versions, and they are defined as follows:

Suggested - this is the version we suggest that you use. It will continue to receive new features, and bug fixes as they are identified.
Beta - this version is currently in beta-testing. There may be some final minor tweaks before the official release.
Supported - do not integrate against this version, and if you're currently utilizing it plan your upgrade to the suggested version before this version is deprecated. Supported versions will continue to receive critical bug fixes, but not new features or accuracy improvements.
Deprecated - do not use this version. If you're integrated to a deprecated version you should plan your upgrade to the suggested version. Deprecated versions do not receive any bug fixes or new features. Deprecated versions may incur higher use of credits.

API Version	Status	Notes
Version 10	Beta	This is the same as v9 under-the-hood, but features an entirely new/modern input/output structure and official SDKs. The output/api might have minor changes before the official release. For more info see Version 9 vs Version 10.
Version 9	Suggested	This is the latest and most accurate version. If you're not already using this version please make plans to upgrade as soon as possible. Full release notes can be found here.
Version 8	Deprecated (6/26/2018)	Do not integrate to v8. If you are using v8, click here to view the upgrade path.
Version 7.5	Deprecated (6/26/2018)	If you're still using the version 7.5 of the API we recommend upgrading straight to version 9. The upgrade path can be found here.

HTTP Status Codes

Our API uses conventional HTTP status codes to describe the overall status of the transaction. The specific code we return are detailed below and mapped to the Info.Code values we return for every transaction:

HTTP Status Code	Info.Code	Description
200 - OK	Success, WarningsFoundDuringParsing, PossibleTruncationFromTimeout, SomeErrors	The transaction was successful
400 - Bad Request	MissingParameter, InvalidParameter, InsufficientData, DataNotFound, CoordinatesNotFound, ConstraintError	Unable to process request
401 - Unauthorized	AuthenticationError, Unauthorized	The AccountId and/or ServiceKey were invalid
403 - Forbidden	N/A	The request was made using http instead of https.
404 - Not Found	DataNotFound	The requested asset wasn't found.
409 - Conflict	DuplicateAsset	The request could not be completed due to a conflict with the current state of the target resource.
422 - Unprocessable Entity	ConversionException	The request made was syntactically correct, but the provided document was unable to be converted to text.
429 - Too Many Requests	TooManyRequests	Your submission has been rejected without being processed because you were exceeding the allowable batch parsing transaction concurrency limit per the AUP. You have been charged for submitting the transaction. It is your responsibility to resubmit this transaction after you correct the process which caused the concurrency problem.
500 - Internal Server Error	UnhandledException	An unexpected issue occurred (these are extremely rare).

Parse a Resume

POST /v10/parser/resume

Parse a single Resume/CV.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
This service is designed to parse resumes/CVs. It assumes that all files passed to it are resumes/CVs. It does not attempt to detect whether a document is a resume/CV or not. It should not be used to try to extract information from other types of documents.
This service supports all commercially viable document formats used for text documents (image formats are not supported). The service does not support parsing of image files (such as TIFF, JPG) or scanned images within supported document file formats. Always send the original file, not the result of copy/paste, not a conversion by some other software, not a scanned image, and not a version marked up with recruiter notes or other non-resume information. Be aware that if you pass garbage into the service, then you are likely to get garbage out. The best results are always obtained by parsing the original resume/CV file.
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.
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Request Body

DocumentAsBase64String required string

A Base64 encoded string of the resume file bytes. This should use the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). .NET users can use the Convert.ToBase64String(byte[]) method.

DocumentLastModified required string

Mandatory date, in YYYY-MM-DD format, so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" or similar. To find out why this is so important and how to calculate/find it, read here. Failing to pass a DocumentLastModified, or passing a DocumentLastModified that is clearly improbable, may result in rejection of data and/or additional charges, and will utterly decimate the usefulness of AI Matching. Use of the DocumentLastModified field is subject to the Acceptable Use Policy.

OutputHtml optional bool

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

OutputRtf optional bool

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

OutputPdf optional bool

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

OutputCandidateImage optional bool

When true, if the document contains inline images, the image that is most likely to be a photo of the candidate is returned as a byte array.

Configuration optional string

Optional parser configuration string to be used for parsing. If not specified, the default parser configuration will be used. For more information regarding the parser configuration string and assistance generating one, refer to the Parser Configuration Documentation.

SkillsData optional string[]

Unavailable except in special cases. Please reach out to support@sovren.com. String[] of your custom skills list names and the Sovren "builtin" skills list. If no list is provided the Sovren builtin skills list will be used. The parser automatically detects language and looks for a corresponding skills list in that language, if no match is found this list is ignored.

NormalizerData optional string

Unavailable except in special cases. Please reach out to support@sovren.com. Name of your custom normalization data file. If no list is provided the Sovren builtin skills list will be used (english only). When using custom normalization files the language to be used is determined by the Parser (the default fall back language is English if the Parser cannot find a match).

GeocodeOptions optional object

Get or insert geocode coordinate values (latitude/longitude) during the parse transaction.

› Show Child Properties

GeocodeOptions.IncludeGeocoding optional bool

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.

GeocodeOptions.Provider optional string

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.

GeocodeOptions.ProviderKey optional string

The Provider Key for the specified Provider. If using Bing you must specify your own provider key.

GeocodeOptions.PostalAddress optional object

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.

› Show Child Properties

GeocodeOptions.PostalAddress.CountryCode optional string

The ISO 3166-1 alpha-2 code indicating the country for the postal address.

GeocodeOptions.PostalAddress.PostalCode optional string

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

GeocodeOptions.PostalAddress.Region optional string

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

GeocodeOptions.PostalAddress.Municipality optional string

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

GeocodeOptions.PostalAddress.AddressLine optional string

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

GeocodeOptions.GeoCoordinates optional object

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.

› Show Child Properties

IndexingOptions optional object

When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions.

› Show Child Properties

{
  "DocumentAsBase64String": "",
  "DocumentLastModified": "",
  "OutputHtml": false,
  "OutputRtf": false,
  "OutputPdf": false,
  "OutputCandidateImage": false,
  "Configuration": "",
  "SkillsData": [
    ""
  ],
  "NormalizerData": "",
  "GeocodeOptions": {
    "IncludeGeocoding": false,
    "Provider": "",
    "ProviderKey": "",
    "PostalAddress": {
      "CountryCode": "",
      "PostalCode": "",
      "Region": "",
      "Municipality": "",
      "AddressLine": ""
    },
    "GeoCoordinates": {
      "Latitude": 0,
      "Longitude": 0
    }
  },
  "IndexingOptions": {
    "IndexId": "",
    "DocumentId": "",
    "UserDefinedTags": [
      ""
    ]
  }
}

Response Body

Info object

Explains the outcome of the transaction.

› Show Child Properties

Info.Code string

A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object

Contains response data for the transaction.

› Show Child Properties

Value.ParsingResponse object

The status of the parse transaction.

› Show Child Properties

Value.GeocodeResponse object

If geocoding was requested in the ParseOptions.GeocodeOptions the status of the geocode transaction will be output here.

› Show Child Properties

Value.GeocodeResponse.Code string

The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

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

Value.GeocodeResponse.Message string

A short human-readable description explaining the Code value.

Value.IndexingResponse object

If indexing was requested in the ParseOptions.IndexingOptions the status of the index transaction will be output here.

› Show Child Properties

Value.IndexingResponse.Code string

The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

DataNotFound - Data with the specified name wasn't found

Value.IndexingResponse.Message string

A short human-readable description explaining the Code value.

Value.ResumeData object

The main output from the Sovren Resume Parser.

› Show Child Properties

Value.ResumeData.ContactInformation object

The candidate's contact information found on the resume.

› Show Child Properties

Value.ResumeData.ContactInformation.CandidateName object

The candidate's name.

› Show Child Properties

Value.ResumeData.ContactInformation.CandidateName.FormattedName string

The name in a standard format.

Value.ResumeData.ContactInformation.CandidateName.Prefix string

A prefix for a name, such as Dr.

Value.ResumeData.ContactInformation.CandidateName.GivenName string

The given (first) name.

Value.ResumeData.ContactInformation.CandidateName.Moniker string

The preferred given (first) name or nickname. This is rarely populated.

Value.ResumeData.ContactInformation.CandidateName.MiddleName string

The middle name or initial.

Value.ResumeData.ContactInformation.CandidateName.FamilyName string

The family (last) name.

Value.ResumeData.ContactInformation.CandidateName.Suffix string

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

Value.ResumeData.ContactInformation.Telephones object[]

The candidate's phone numbers. If multiple numbers are found, mobile phone numbers will be listed first.

› Show Child Properties

Value.ResumeData.ContactInformation.Telephones[i].Raw string

The raw value found in the text.

Value.ResumeData.ContactInformation.Telephones[i].Normalized string

The normalized value.

Value.ResumeData.ContactInformation.Telephones[i].InternationalCountryCode string

The international country code part of the phone number.

Value.ResumeData.ContactInformation.Telephones[i].AreaCityCode string

The area code part of the phone number.

Value.ResumeData.ContactInformation.Telephones[i].SubscriberNumber string

The subscriber number part of the phone number.

Value.ResumeData.ContactInformation.EmailAddresses string[]

The candidate's email addresses.

Value.ResumeData.ContactInformation.Location object

The candidate's location/address

› Show Child Properties

Value.ResumeData.ContactInformation.Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.ResumeData.ContactInformation.Location.PostalCode string

The Postal or Zip code.

Value.ResumeData.ContactInformation.Location.Regions string[]

The Regions/Districts/States.

Value.ResumeData.ContactInformation.Location.Municipality string

The City/Municipality/Town.

Value.ResumeData.ContactInformation.Location.StreetAddressLines string

Street address lines.

Value.ResumeData.ContactInformation.Location.GeoCoordinates object

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

› Show Child Properties

Value.ResumeData.ContactInformation.Location.GeoCoordinates.Latitude decimal

The latitude, in degrees.

Value.ResumeData.ContactInformation.Location.GeoCoordinates.Longitude decimal

The longitude, in degrees.

Value.ResumeData.ContactInformation.Location.GeoCoordinates.Source string

The geocoding source, such as Google or Bing.

Value.ResumeData.ContactInformation.WebAddresses object[]

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

› Show Child Properties

Value.ResumeData.ProfessionalSummary string

The professional summary from the resume.

Value.ResumeData.Objective string

The candidate's written objective.

Value.ResumeData.PersonalAttributes object

Personal information provided by the candidate on the resume.

› Show Child Properties

Value.ResumeData.PersonalAttributes.Availability string

The availability of the candidate.

Value.ResumeData.PersonalAttributes.Birthplace string

The birthplace of the candidate.

Value.ResumeData.PersonalAttributes.CurrentLocation string

The current location listed on the resume.

Value.ResumeData.PersonalAttributes.CurrentSalary object

The current salary listed on the resume.

› Show Child Properties

Value.ResumeData.PersonalAttributes.DateOfBirth object

The date of birth given on the resume

› Show Child Properties

Value.ResumeData.PersonalAttributes.DateOfBirth.Date date

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

Value.ResumeData.PersonalAttributes.DateOfBirth.IsCurrentDate bool

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

Value.ResumeData.PersonalAttributes.DateOfBirth.FoundYear bool

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

Value.ResumeData.PersonalAttributes.DateOfBirth.FoundMonth bool

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

Value.ResumeData.PersonalAttributes.DateOfBirth.FoundDay bool

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

Value.ResumeData.PersonalAttributes.DrivingLicense string

A driving license listed on the resume.

Value.ResumeData.PersonalAttributes.FamilyComposition string

The family composition.

Value.ResumeData.PersonalAttributes.FathersName string

The candidate's father's name listed on the resume.

Value.ResumeData.PersonalAttributes.Gender string

The candidate's gender listed on the resume.

Value.ResumeData.PersonalAttributes.HukouCity string

Used in Chinese resumes.

Value.ResumeData.PersonalAttributes.HukouArea string

Used in Chinese resumes.

Value.ResumeData.PersonalAttributes.MaritalStatus string

The marital status listed on the resume.

Value.ResumeData.PersonalAttributes.MothersMaidenName string

The candidate's mother's maiden name listed on the resume.

Value.ResumeData.PersonalAttributes.MotherTongue string

The candidate's mother tongue (native language) listed on the resume.

Value.ResumeData.PersonalAttributes.NationalIdentities object[]

Any national identities provided on the resume.

› Show Child Properties

Value.ResumeData.PersonalAttributes.Nationality string

The candidate's nationality listed on the resume.

Value.ResumeData.PersonalAttributes.PassportNumber string

The candidate's passport number listed on the resume.

Value.ResumeData.PersonalAttributes.PreferredLocation string

The candidate's preferred location listed on the resume.

Value.ResumeData.PersonalAttributes.RequiredSalary object

The candidate's required salary listed on the resume.

› Show Child Properties

Value.ResumeData.PersonalAttributes.VisaStatus string

The candidate's visa status listed on the resume.

Value.ResumeData.PersonalAttributes.WillingToRelocate string

Whether the candidate is willing to relocate.

Value.ResumeData.Education object

The candidate's education history found on the resume.

› Show Child Properties

Value.ResumeData.Education.HighestDegree object

The highest degree obtained by a candidate

› Show Child Properties

Value.ResumeData.Education.HighestDegree.Name object

The name of the degree

› Show Child Properties

Value.ResumeData.Education.HighestDegree.Type string

The type of degree.

Value.ResumeData.Education.EducationDetails object[]

All of the education details listed on a resume

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].Id string

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

Value.ResumeData.Education.EducationDetails[i].Text string

The raw text from the resume.

Value.ResumeData.Education.EducationDetails[i].SchoolName object

The name of the school attended

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].SchoolType string

The type of the school attended. One of: { "UNSPECIFIED", "lowerSchool", "highschool", "secondary", "trade", "professional", "vocational", "community", "college", "university" }

Value.ResumeData.Education.EducationDetails[i].Location object

The Country/Region/City of the school, if found

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.ResumeData.Education.EducationDetails[i].Location.PostalCode string

The Postal or Zip code.

Value.ResumeData.Education.EducationDetails[i].Location.Regions string[]

The Regions/Districts/States.

Value.ResumeData.Education.EducationDetails[i].Location.Municipality string

The City/Municipality/Town.

Value.ResumeData.Education.EducationDetails[i].Location.StreetAddressLines string

Street address lines

Value.ResumeData.Education.EducationDetails[i].Location.GeoCoordinates object

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

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].Location.Latitude decimal

The latitude, in degrees.

Value.ResumeData.Education.EducationDetails[i].Location.Longitude decimal

The longitude, in degrees.

Value.ResumeData.Education.EducationDetails[i].Location.Source string

The geocoding source, such as Google or Bing.

Value.ResumeData.Education.EducationDetails[i].Degree object

The degree obtained (or worked toward)

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].Degree.Name object

The name of the degree

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].Degree.Type string

The type of degree.

Value.ResumeData.Education.EducationDetails[i].Majors string[]

Any majors/areas of major focus.

Value.ResumeData.Education.EducationDetails[i].Minors string[]

Any minors/areas of minor focus.

Value.ResumeData.Education.EducationDetails[i].GPA object

The GPA/marks listed on the resume

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].GPA.Score string

The score found in the resume.

Value.ResumeData.Education.EducationDetails[i].GPA.ScoringSystem string

The scoring system used on the resume.

Value.ResumeData.Education.EducationDetails[i].GPA.MaxScore string

The max score in the scoring system.

Value.ResumeData.Education.EducationDetails[i].GPA.MinimumScore string

The minimum score in the scoring system.

Value.ResumeData.Education.EducationDetails[i].GPA.NormalizedScore decimal

The score, normalized to a 0.0-1.0 scale

Value.ResumeData.Education.EducationDetails[i].LastEducationDate object

The date graduated or education ended

› Show Child Properties

Value.ResumeData.Education.EducationDetails[i].Date.Date date

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

Value.ResumeData.Education.EducationDetails[i].Date..IsCurrentDate bool

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

Value.ResumeData.Education.EducationDetails[i].Date.FoundYear bool

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

Value.ResumeData.Education.EducationDetails[i].Date.FoundMonth bool

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

Value.ResumeData.Education.EducationDetails[i].Date.FoundDay bool

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

Value.ResumeData.Education.EducationDetails[i].Graduated object

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

› Show Child Properties

Value.ResumeData.EmploymentHistory object

The candidate's employment/work history found on the resume.

› Show Child Properties

Value.ResumeData.EmploymentHistory.ExperienceSummary string

A summary of all the work history with important calculated metadata

› Show Child Properties

Value.ResumeData.EmploymentHistory.ExperienceSummary.Description string

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.

Value.ResumeData.EmploymentHistory.ExperienceSummary.MonthsOfWorkExperience integer

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.

Value.ResumeData.EmploymentHistory.ExperienceSummary.MonthsOfManagementExperience integer

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.

Value.ResumeData.EmploymentHistory.ExperienceSummary.ExecutiveType string

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" }

Value.ResumeData.EmploymentHistory.ExperienceSummary.AverageMonthsPerEmployer integer

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.

Value.ResumeData.EmploymentHistory.ExperienceSummary.FulltimeDirectHirePredictiveIndex integer

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.

Value.ResumeData.EmploymentHistory.ExperienceSummary.ManagementStory string

A paragraph of text that summarizes the candidate's management experience (in English).

Value.ResumeData.EmploymentHistory.ExperienceSummary.CurrentManagementLevel string

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" }

Value.ResumeData.EmploymentHistory.ExperienceSummary.ManagementScore integer

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

Value.ResumeData.EmploymentHistory.ExperienceSummary.AttentionNeeded string

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.

Value.ResumeData.EmploymentHistory.Positions object[]

A list of jobs/positions found on the resume.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Id string

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

Value.ResumeData.EmploymentHistory.Positions[i].Employer object

The employer/company for this position. Will be null if IsSelfEmployed is null.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Name object

The name of the employer (and an accuracy probability).

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Employer.NameRaw string

The raw value found in the text.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.NameNormalized string

The normalized value.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.NameProbability string

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

Value.ResumeData.EmploymentHistory.Positions[i].Employer.OtherFoundName object

Sometimes a second possible company name is found, or a department/organization within a company. This is that value, if it is found.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location object

The location/address of the employer.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.PostalCode string

The Postal or Zip code.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.Regions string[]

The Regions/Districts/States.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.Municipality string

The City/Municipality/Town.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.StreetAddressLines string

Street address lines.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates object

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

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Latitude decimal

The latitude, in degrees.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Longitude decimal

The longitude, in degrees.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Source string

The geocoding source, such as Google or Bing.

Value.ResumeData.EmploymentHistory.Positions[i].RelatedToByDates string[]

A list of other positions Ids that have overlapping dates with this Position.

Value.ResumeData.EmploymentHistory.Positions[i].RelatedToByCompanyName string[]

A list of other positions Ids that have the same Employer as this Position.

Value.ResumeData.EmploymentHistory.Positions[i].IsSelfEmployed bool

True if the candidate was self-employed at this job/position.

Value.ResumeData.EmploymentHistory.Positions[i].IsCurrent bool

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

Value.ResumeData.EmploymentHistory.Positions[i].JobTitle object

The job title for this position/job.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].Employer.JobTitle.Raw string

The raw text as it was found in the resume.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.JobTitle.Normalized string

The normalized job title.

Value.ResumeData.EmploymentHistory.Positions[i].Employer.JobTitle.Probability string

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

Value.ResumeData.EmploymentHistory.Positions[i].Employer.JobTitle.Variations string[]

Any variations of this job title that might be useful for matching.

Value.ResumeData.EmploymentHistory.Positions[i].StartDate object

The start date listed for this position.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].StartDate.Date date

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

Value.ResumeData.EmploymentHistory.Positions[i].StartDate.IsCurrentDate bool

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

Value.ResumeData.EmploymentHistory.Positions[i].StartDate.FoundYear bool

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

Value.ResumeData.EmploymentHistory.Positions[i].StartDate.FoundMonth bool

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

Value.ResumeData.EmploymentHistory.Positions[i].StartDate.FoundDay bool

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

Value.ResumeData.EmploymentHistory.Positions[i].EndDate object

The end date listed for this position

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].EndDate.Date date

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

Value.ResumeData.EmploymentHistory.Positions[i].EndDate.IsCurrentDate bool

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

Value.ResumeData.EmploymentHistory.Positions[i].EndDate.FoundYear bool

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

Value.ResumeData.EmploymentHistory.Positions[i].EndDate.FoundMonth bool

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

Value.ResumeData.EmploymentHistory.Positions[i].EndDate.FoundDay bool

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

Value.ResumeData.EmploymentHistory.Positions[i].NumberEmployeesSupervised object

How many employees were supervised in this position/job, or null.

› Show Child Properties

Value.ResumeData.EmploymentHistory.Positions[i].JobType string

The type of job. One of: { "directHire", "contract", "temp", "volunteer", "internship", "UNSPECIFIED" }

Value.ResumeData.EmploymentHistory.Positions[i].TaxonomyName string

The name of the skills taxonomy that this position was categorized as based on skills found in the job description.

Value.ResumeData.EmploymentHistory.Positions[i].SubTaxonomyName string

The name of the skills subtaxonomy that this position was categorized as based on skills found in the job description.

Value.ResumeData.EmploymentHistory.Positions[i].JobLevel string

The level determined by length of experience and job titles. One of: { "Entry Level", "Experienced (non-manager)", "Senior (more than 5 years experience)", "Senior Manager (more than 5 years management experience)", "Executive (VP, Dept Head)", "Senior Executive (President, C-level)" }

Value.ResumeData.EmploymentHistory.Positions[i].TaxonomyPercentage integer

The percentage of this job described by the TaxonomyName.

Value.ResumeData.EmploymentHistory.Positions[i].Description string

The job description.

Value.ResumeData.SkillsData object[]

All the skills found in the resume.

› Show Child Properties

Value.ResumeData.SkillsData[i].Root string

The name of the skills list that these taxonomies belong to.

Value.ResumeData.SkillsData[i].Taxonomies object[]

The skills taxonomies found in a resume.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].Id string

The id of the skills taxonomy.

Value.ResumeData.SkillsData[i].Taxonomies[j].Name string

The human-readable name.

Value.ResumeData.SkillsData[i].Taxonomies[j].PercentOfOverall integer

The percent (0-100) of skills found in the document that belong to this taxonomy.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies object[]

The subtaxonomy children of this taxonomy (more specific groupings of skills).

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].SubTaxonomyId string

The id of the subtaxonomy.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].SubTaxonomyName string

The human-readable name of the subtaxonomy.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].PercentOfOverall integer

The percent (0-100) of skills found in the subtaxonomy compared to all subtaxonomies.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].PercentOfParent integer

The percent (0-100) of skills found in the subtaxonomy compared to other subtaxonomies in the parent taxonomy

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills object[]

The skills from the subtaxonomy that were found.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Id string

The Id of the skill.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Name string

The name of the skill.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].FoundIn object

Where the skill was found.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].FoundIn.SectionType string

The section where the skill was found.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].FoundIn.Id string

If applicable, the Position ID or Education Id.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].ExistsInText string

Whether or not this skill was found verbatim in the text.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].MonthsExperience object

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

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].LastUsed object

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

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].ChildrenMonthsExperience object

If this skill has any varitaions, this describes the total months experience of those variations. Null if unknown/not-applicable.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].ChildrenLastUsed object

If this skill has any varitaions, this describes the most recent date any of the varitaions were used. Null if unknown/not-applicable.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations object[]

The variations (synonyms) of this skill that were found.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].MonthsExperience object

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

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].LastUsed object

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

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Id string

The Id of the skill.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Name string

The name of the skill.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].FoundIn object

Where the skill was found.

› Show Child Properties

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].FoundIn.Section string

The section where the skill was found.

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].FoundIn.Id string

The education or position ID where the skill was found

Value.ResumeData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].ExistsInText string

Whether or not this skill was found verbatim in the text.

Value.ResumeData.Certifications object[]

Certifications found on a resume.

› Show Child Properties

Value.ResumeData.Licenses object[]

Licenses found on a resume. These are professional licenses, not driving licenses. For driving licenses, see PersonalAttributes.

› Show Child Properties

Value.ResumeData.Associations object[]

Associations/organizations found on a resume.

› Show Child Properties

Value.ResumeData.LanguageCompetencies object[]

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

› Show Child Properties

Value.ResumeData.MilitaryExperience object[]

Any military experience listed on the resume.

› Show Child Properties

Value.ResumeData.MilitaryExperience[i].Country string

The country that the military belongs to.

Value.ResumeData.MilitaryExperience[i].Service object

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

› Show Child Properties

Value.ResumeData.MilitaryExperience[i].Service.Name string

The name of the military post/job.

Value.ResumeData.MilitaryExperience[i].Service.Branch string

The branch of the military.

Value.ResumeData.MilitaryExperience[i].Service.Rank string

he military rank of the candidate.

Value.ResumeData.MilitaryExperience[i].StartDate object

The start date for this military post/job.

› Show Child Properties

Value.ResumeData.MilitaryExperience[i].StartDate.Date date

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

Value.ResumeData.MilitaryExperience[i].StartDate.IsCurrentDate bool

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

Value.ResumeData.MilitaryExperience[i].StartDate.FoundYear bool

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

Value.ResumeData.MilitaryExperience[i].StartDate.FoundMonth bool

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

Value.ResumeData.MilitaryExperience[i].StartDate.FoundDay bool

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

Value.ResumeData.MilitaryExperience[i].EndDate object

The end date for this military post/job.

› Show Child Properties

Value.ResumeData.MilitaryExperience[i].EndDate.Date date

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

Value.ResumeData.MilitaryExperience[i].EndDate.IsCurrentDate bool

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

Value.ResumeData.MilitaryExperience[i].EndDate.FoundYear bool

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

Value.ResumeData.MilitaryExperience[i].EndDate.FoundMonth bool

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

Value.ResumeData.MilitaryExperience[i].EndDate.FoundDay bool

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

Value.ResumeData.MilitaryExperience[i].FoundInContext string

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

Value.ResumeData.SecurityCredentials object[]

Any security credentials/clearances listed on the resume.

› Show Child Properties

Value.ResumeData.References object[]

References listed on a resume.

› Show Child Properties

Value.ResumeData.References[i].ReferenceName object

The name of the reference.

› Show Child Properties

Value.ResumeData.References[i].ReferenceName.FormattedName string

The name in a standard format.

Value.ResumeData.References[i].ReferenceName.Prefix string

A prefix for a name, such as Dr.

Value.ResumeData.References[i].ReferenceName.GivenName string

The given (first) name.

Value.ResumeData.References[i].ReferenceName.MiddleName string

The middle name or initial.

Value.ResumeData.References[i].ReferenceName.FamilyName string

The family (last) name.

Value.ResumeData.References[i].ReferenceName.Suffix string

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

Value.ResumeData.References[i].Title string

The job title of the reference.

Value.ResumeData.References[i].Company string

The employer of the reference.

Value.ResumeData.References[i].Type string

The type of reference.

Value.ResumeData.References[i].Location object

The physical location of the reference.

› Show Child Properties

Value.ResumeData.References[i].Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.ResumeData.References[i].Location.PostalCode string

The Postal or Zip code.

Value.ResumeData.References[i].Location.Regions string[]

The Regions/Districts/States.

Value.ResumeData.References[i].Location.Municipality string

The City/Municipality/Town.

Value.ResumeData.References[i].Location.StreetAddressLines string

Street address lines.

Value.ResumeData.References[i].Location.GeoCoordinates object

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

› Show Child Properties

Value.ResumeData.References[i].Location.GeoCoordinates.Latitude decimal

The latitude, in degrees.

Value.ResumeData.References[i].Location.GeoCoordinates.Longitude decimal

The longitude, in degrees.

Value.ResumeData.References[i].Location.GeoCoordinates.Source string

The geocoding source, such as Google or Bing.

Value.ResumeData.References[i].Telephones object[]

Phone numbers listed for the reference.

› Show Child Properties

Value.ResumeData.References[i].EmailAddresses string[]

Email addresses listed for the reference.

Value.ResumeData.References[i].WebAddresses object[]

Other web addresses listed for the reference.

› Show Child Properties

Value.ResumeData.Achievements string[]

Any achievements listed on the resume.

Value.ResumeData.Training object

Any training listed on the resume.

› Show Child Properties

Value.ResumeData.Training.Text string

The full text where we found all training history.

Value.ResumeData.Training.Trainings object[]

Information about each training history we found.

› Show Child Properties

Value.ResumeData.Training.Trainings[i].Text string

The text that was found on the resume.

Value.ResumeData.Training.Trainings[i].Entity string

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

Value.ResumeData.Training.Trainings[i].Qualifications string[]

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.

Value.ResumeData.Training.Trainings[i].StartDate object

The date the training started.

› Show Child Properties

Value.ResumeData.Training.Trainings[i].StartDate.Date date

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

Value.ResumeData.Training.Trainings[i].StartDate.IsCurrentDate bool

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

Value.ResumeData.Training.Trainings[i].StartDate.FoundYear bool

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

Value.ResumeData.Training.Trainings[i].StartDate.FoundMonth bool

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

Value.ResumeData.Training.Trainings[i].StartDate.FoundDay bool

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

Value.ResumeData.Training.Trainings[i].EndDate object

The date the training ended.

› Show Child Properties

Value.ResumeData.Training.Trainings[i].EndDate.Date date

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

Value.ResumeData.Training.Trainings[i].EndDate.IsCurrentDate bool

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

Value.ResumeData.Training.Trainings[i].EndDate.FoundYear bool

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

Value.ResumeData.Training.Trainings[i].EndDate.FoundMonth bool

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

Value.ResumeData.Training.Trainings[i].EndDate.FoundDay bool

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

Value.ResumeData.Hobbies string

Any hobbies listed on the resume.

Value.ResumeData.Patents string

Any patents listed on the resume.

Value.ResumeData.Publications string

Any publications listed on the resume.

Value.ResumeData.SpeakingEngagements string

Any speaking engagements/appearances listed on the resume.

Value.ResumeData.ResumeMetadata object

Metadata about the parsed resume.

› Show Child Properties

Value.ResumeData.ResumeMetadata.PlainText string

The plain text that was used for parsing.

Value.ResumeData.ResumeMetadata.DocumentLanguage string

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

Value.ResumeData.ResumeMetadata.DocumentCulture string

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

Value.ResumeData.ResumeMetadata.ParserSettings string

The full parser settings that were used during parsing.

Value.ResumeData.ResumeMetadata.DocumentLastModified date

The last-revised/last-modified date that was provided for the document. This was used to calculate all of the important metrics about skills and jobs.

Value.ResumeData.ResumeMetadata.SovrenSignature string[]

A digital signature used to ensure there is no tampering between parsing and indexing. This prevents Sovren from storing any PII in the AI Matching engine.

Value.ResumeData.ResumeMetadata.FoundSections object[]

A list of sections found in the resume

› Show Child Properties

Value.ResumeData.ResumeMetadata.FoundSections[i].FirstLineNumber integer

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

Value.ResumeData.ResumeMetadata.FoundSections[i].LastLineNumber integer

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

Value.ResumeData.ResumeMetadata.FoundSections[i].SectionType string

The type of section. Some possibilites: { "CONTACT_INFO", "EDUCATION", "WORK_HISTORY", "SKILLS", "CERTIFICATIONS" } See resume metadata documentation for a full list.

Value.ResumeData.ResumeMetadata.FoundSections[i].HeaderTextFound string

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"

Value.ResumeData.ResumeMetadata.ResumeQuality object[]

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.

› Show Child Properties

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Level string

The level/severity of this assessment. One of: { "Suggested Improvements", "Data Missing", "Major Issues Found", "Fatal Problems Found" }

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Findings object[]

A list of findings of the same severity/level.

› Show Child Properties

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Findings[j].QualityCode string

A unique 3-digit code to identify what type of issue was found. See all possibilities here.

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Findings[j].Identifiers object[]

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

› Show Child Properties

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Findings[j].Identifiers[k].SectionType string

The section where the issue was found.

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Findings[j].Identifiers[k].Id string

If applicable, the Position ID or Education Id.

Value.ResumeData.ResumeMetadata.ResumeQuality[i].Findings[j].Message string

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

Value.ResumeData.ResumeMetadata.ReservedData object

Used by Sovren to redact PII.

› Show Child Properties

Value.ResumeData.ResumeMetadata.ReservedData.Phones string[]

All phone numbers found in the resume.

Value.ResumeData.ResumeMetadata.ReservedData.Names string[]

All names found in the resume.

Value.ResumeData.ResumeMetadata.ReservedData.EmailAddresses string[]

All email addresses found in the resume.

Value.ResumeData.ResumeMetadata.ReservedData.Urls string[]

All personal urls found in the resume.

Value.ResumeData.ResumeMetadata.ReservedData.OtherData string[]

Any other PII that should be redacted.

Value.ResumeData.UserDefinedTags string[]

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

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

Value.RedactedResumeData object

This property is the Value.ResumeData with all of the Personally Identifiable Information (PII) fields such as first name, last name, email addresses, phone numbers, etc. redacted.

Value.ConversionMetadata object

Information about converting the document to plain text

› Show Child Properties

Value.ConversionMetadata.DetectedType string

The file type that was detected.

Value.ConversionMetadata.SuggestedFileExtension string

The suggested extension based on the DetectedType.

Value.ConversionMetadata.OutputValidityCode string

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.

Value.ConversionMetadata.ElapsedMilliseconds string

How long the document conversion took, in milliseconds.

Value.Conversions object

Any additional conversions you requested will be here (eg: PDF or HTML).

› Show Child Properties

Value.Conversions.PDF string

If requested by ParseOptions.OutputPdf, this is the document converted to a PDF. This is a byte[] as a Base64-encoded string.

Value.Conversions.HTML string

If requested by ParseOptions.OutputPdf, this is the document converted to HTML.

Value.Conversions.RTF string

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

Value.Conversions.CandidateImage string

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

Value.Conversions.CandidateImageExtension string

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

Value.ParsingMetadata object

Information about the parsing transaction.

› Show Child Properties

Value.ParsingMetadata.ElapsedMilliseconds string

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

Value.ParsingMetadata.TimedOut bool

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

Value.ParsingMetadata.TimedOutAtMilliseconds object

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

› Show Child Properties

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "ParsingResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "GeocodeResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "IndexingResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "ResumeData": {
      "ContactInformation": {
        "CandidateName": {
          "FormattedName": "string",
          "Prefix": "string",
          "GivenName": "string",
          "Moniker": "string",
          "MiddleName": "string",
          "FamilyName": "string",
          "Suffix": "string"
        },
        "Telephones": [
          {
            "Raw": "string",
            "Normalized": "string",
            "InternationalCountryCode": "string",
            "AreaCityCode": "string",
            "SubscriberNumber": "string"
          }
        ],
        "EmailAddresses": [
          "string"
        ],
        "Location": {
          "CountryCode": "string",
          "PostalCode": "string",
          "Regions": [
            "string"
          ],
          "Municipality": "string",
          "StreetAddressLines": [
            "string"
          ],
          "GeoCoordinates": {
            "Latitude": 0,
            "Longitude": 0,
            "Source": "string"
          }
        },
        "WebAddresses": [
          {
            "Address": "string",
            "Type": "string"
          }
        ]
      },
      "ProfessionalSummary": "string",
      "Objective": "string",
      "CoverLetter": "string",
      "PersonalAttributes": {
        "Availability": "string",
        "Birthplace": "string",
        "CurrentLocation": "string",
        "CurrentSalary": {
          "Currency": "string",
          "Amount": 0
        },
        "DateOfBirth": {
          "Date": "2020-11-02",
          "IsCurrentDate": true,
          "FoundYear": true,
          "FoundMonth": true,
          "FoundDay": true
        },
        "DrivingLicense": "string",
        "FamilyComposition": "string",
        "FathersName": "string",
        "Gender": "string",
        "HukouCity": "string",
        "HukouArea": "string",
        "MaritalStatus": "string",
        "MothersMaidenName": "string",
        "MotherTongue": "string",
        "NationalIdentities": [
          {
            "Number": "string",
            "Phrase": "string"
          }
        ],
        "Nationality": "string",
        "PassportNumber": "string",
        "PreferredLocation": "string",
        "RequiredSalary": {
          "Currency": "string",
          "Amount": 0
        },
        "VisaStatus": "string",
        "WillingToRelocate": "string"
      },
      "Education": {
        "HighestDegree": {
          "Name": {
            "Raw": "string",
            "Normalized": "string"
          },
          "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,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "Graduated": {
              "Value": true
            }
          }
        ]
      },
      "EmploymentHistory": {
        "ExperienceSummary": {
          "Description": "string",
          "MonthsOfWorkExperience": 0,
          "MonthsOfManagementExperience": 0,
          "ExecutiveType": "string",
          "AverageMonthsPerEmployer": 0,
          "FulltimeDirectHirePredictiveIndex": 0,
          "ManagementStory": "string",
          "CurrentManagementLevel": "string",
          "ManagementScore": 0,
          "AttentionNeeded": "string"
        },
        "Positions": [
          {
            "Id": "string",
            "Employer": {
              "Name": {
                "Probability": "string",
                "Raw": "string",
                "Normalized": "string"
              },
              "OtherFoundName": {
                "Raw": "string",
                "Normalized": "string"
              },
              "Location": {
                "CountryCode": "string",
                "PostalCode": "string",
                "Regions": [
                  "string"
                ],
                "Municipality": "string",
                "StreetAddressLines": [
                  "string"
                ],
                "GeoCoordinates": {
                  "Latitude": 0,
                  "Longitude": 0,
                  "Source": "string"
                }
              }
            },
            "RelatedToByDates": [
              "string"
            ],
            "RelatedToByCompanyName": [
              "string"
            ],
            "IsSelfEmployed": true,
            "IsCurrent": true,
            "JobTitle": {
              "Raw": "string",
              "Normalized": "string",
              "Probability": "string",
              "Variations": [
                "string"
              ]
            },
            "StartDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "EndDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "NumberEmployeesSupervised": {
              "Value": 0
            },
            "JobType": "string",
            "TaxonomyName": "string",
            "SubTaxonomyName": "string",
            "JobLevel": "string",
            "TaxonomyPercentage": "string",
            "Description": "string",
            "Bullets": [
              {
                "Type": "string",
                "Text": "string"
              }
            ]
          }
        ]
      },
      "SkillsData": [
        {
          "Root": "string",
          "Taxonomies": [
            {
              "Id": "string",
              "Name": "string",
              "PercentOfOverall": 0,
              "SubTaxonomies": [
                {
                  "PercentOfOverall": 0,
                  "PercentOfParent": 0,
                  "SubTaxonomyId": "string",
                  "SubTaxonomyName": "string",
                  "Skills": [
                    {
                      "Id": "string",
                      "Name": "string",
                      "FoundIn": {
                        "SectionType": "string",
                        "Id": "string",
                      },
                      "ExistsInText": true,
                      "Variations": [
                        {
                          "MonthsExperience": {
                            "Value": 0
                          },
                          "LastUsed": {
                            "Value": "2020-11-02"
                          },
                          "Id": "string",
                          "Name": "string",
                          "FoundIn": {
                           "SectionType": "string",
                           "Id": "string",
                          },
                          "ExistsInText": true
                        }
                      ],
                      "MonthsExperience": {
                        "Value": 0
                      },
                      "LastUsed": {
                        "Value": "2020-11-02"
                      },
                      "ChildrenMonthsExperience": {
                        "Value": 0
                      },
                      "ChildrenLastUsed": {
                        "Value": "2020-11-02"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "Certifications": [
        {
          "Name": "string",
          "MatchedFromList": true
        }
      ],
      "Licenses": [
        {
          "Name": "string",
          "MatchedFromList": true
        }
      ],
      "Associations": [
        {
          "Organization": "string",
          "Role": "string",
          "FoundInContext": "string"
        }
      ],
      "LanguageCompetencies": [
        {
          "Language": "string",
          "LanguageCode": "string",
          "FoundInContext": "string"
        }
      ],
      "MilitaryExperience": [
        {
          "Country": "string",
          "Service": {
            "Name": "string",
            "Branch": "string",
            "Rank": "string"
          },
          "StartDate": {
            "Date": "2020-11-02",
            "IsCurrentDate": true,
            "FoundYear": true,
            "FoundMonth": true,
            "FoundDay": true
          },
          "EndDate": {
            "Date": "2020-11-02",
            "IsCurrentDate": true,
            "FoundYear": true,
            "FoundMonth": true,
            "FoundDay": true
          },
          "FoundInContext": "string"
        }
      ],
      "SecurityCredentials": [
        {
          "Name": "string",
          "FoundInContext": "string"
        }
      ],
      "References": [
        {
          "ReferenceName": {
            "FormattedName": "string",
            "Prefix": "string",
            "GivenName": "string",
            "Moniker": "string",
            "MiddleName": "string",
            "FamilyName": "string",
            "Suffix": "string"
          },
          "Title": "string",
          "Company": "string",
          "Type": "string",
          "Location": {
            "CountryCode": "string",
            "PostalCode": "string",
            "Regions": [
              "string"
            ],
            "Municipality": "string",
            "StreetAddressLines": [
              "string"
            ],
            "GeoCoordinates": {
              "Latitude": 0,
              "Longitude": 0,
              "Source": "string"
            }
          },
          "Telephones": [
            {
              "Raw": "string",
              "Normalized": "string"
            }
          ],
          "EmailAddresses": [
            "string"
          ],
          "WebAddresses": [
            {
              "Address": "string",
              "Type": "string"
            }
          ]
        }
      ],
      "Achievements": [
        "string"
      ],
      "Training": {
        "Text": "string",
        "Trainings": [
          {
            "Text": "string",
            "Entity": "string",
            "Qualifications": [
              "string"
            ],
            "StartDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "EndDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            }
          }
        ]
      },
      "Hobbies": "string",
      "Patents": "string",
      "Publications": "string",
      "SpeakingEngagements": "string",
      "ResumeMetadata": {
        "FoundSections": [
          {
            "FirstLineNumber": 0,
            "LastLineNumber": 0,
            "SectionType": "string",
            "HeaderTextFound": "string"
          }
        ],
        "ResumeQuality": [
          {
            "Level": "string",
            "Findings": [
              {
                "QualityCode": "string",
                "SectionIdentifiers": [
                  {
                    "SectionType": "string",
                    "Id": "string",
                  },
                ],
                "Message": "string"
              }
            ]
          }
        ],
        "ReservedData": {
          "Phones": [
            "string"
          ],
          "Names": [
            "string"
          ],
          "EmailAddresses": [
            "string"
          ],
          "Urls": [
            "string"
          ],
          "OtherData": [
            "string"
          ]
        },
        "PlainText": "string",
        "DocumentLanguage": "string",
        "DocumentCulture": "string",
        "ParserSettings": "string",
        "DocumentLastModified": "2020-11-02",
        "SovrenSignature": [
          "string"
        ]
      },
      "UserDefinedTags": [
        "string"
      ]
    },
    "RedactedResumeData": {
      "ContactInformation": {
        "CandidateName": {
          "FormattedName": "string",
          "Prefix": "string",
          "GivenName": "string",
          "Moniker": "string",
          "MiddleName": "string",
          "FamilyName": "string",
          "Suffix": "string"
        },
        "Telephones": [
          {
            "Raw": "string",
            "Normalized": "string",
            "InternationalCountryCode": "string",
            "AreaCityCode": "string",
            "SubscriberNumber": "string"
          }
        ],
        "EmailAddresses": [
          "string"
        ],
        "Location": {
          "CountryCode": "string",
          "PostalCode": "string",
          "Regions": [
            "string"
          ],
          "Municipality": "string",
          "StreetAddressLines": [
            "string"
          ],
          "GeoCoordinates": {
            "Latitude": 0,
            "Longitude": 0,
            "Source": "string"
          }
        },
        "WebAddresses": [
          {
            "Address": "string",
            "Type": "string"
          }
        ]
      },
      "ProfessionalSummary": "string",
      "Objective": "string",
      "CoverLetter": "string",
      "PersonalAttributes": {
        "Availability": "string",
        "Birthplace": "string",
        "CurrentLocation": "string",
        "CurrentSalary": {
          "Currency": "string",
          "Amount": 0
        },
        "DateOfBirth": {
          "Date": "2020-11-02",
          "IsCurrentDate": true,
          "FoundYear": true,
          "FoundMonth": true,
          "FoundDay": true
        },
        "DrivingLicense": "string",
        "FamilyComposition": "string",
        "FathersName": "string",
        "Gender": "string",
        "HukouCity": "string",
        "HukouArea": "string",
        "MaritalStatus": "string",
        "MothersMaidenName": "string",
        "MotherTongue": "string",
        "NationalIdentities": [
          {
            "Number": "string",
            "Phrase": "string"
          }
        ],
        "Nationality": "string",
        "PassportNumber": "string",
        "PreferredLocation": "string",
        "RequiredSalary": {
          "Currency": "string",
          "Amount": 0
        },
        "VisaStatus": "string",
        "WillingToRelocate": "string"
      },
      "Education": {
        "HighestDegree": {
          "Name": {
            "Raw": "string",
            "Normalized": "string"
          },
          "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,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "Graduated": {
              "Value": true
            }
          }
        ]
      },
      "EmploymentHistory": {
        "ExperienceSummary": {
          "Description": "string",
          "MonthsOfWorkExperience": 0,
          "MonthsOfManagementExperience": 0,
          "ExecutiveType": "string",
          "AverageMonthsPerEmployer": 0,
          "FulltimeDirectHirePredictiveIndex": 0,
          "ManagementStory": "string",
          "CurrentManagementLevel": "string",
          "ManagementScore": 0,
          "AttentionNeeded": "string"
        },
        "Positions": [
          {
            "Id": "string",
            "Employer": {
              "Name": {
                "Probability": "string",
                "Raw": "string",
                "Normalized": "string"
              },
              "OtherFoundName": {
                "Raw": "string",
                "Normalized": "string"
              },
              "Location": {
                "CountryCode": "string",
                "PostalCode": "string",
                "Regions": [
                  "string"
                ],
                "Municipality": "string",
                "StreetAddressLines": [
                  "string"
                ],
                "GeoCoordinates": {
                  "Latitude": 0,
                  "Longitude": 0,
                  "Source": "string"
                }
              }
            },
            "RelatedToByDates": [
              "string"
            ],
            "RelatedToByCompanyName": [
              "string"
            ],
            "IsSelfEmployed": true,
            "IsCurrent": true,
            "JobTitle": {
              "Raw": "string",
              "Normalized": "string",
              "Probability": "string",
              "Variations": [
                "string"
              ]
            },
            "StartDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "EndDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "NumberEmployeesSupervised": {
              "Value": 0
            },
            "JobType": "string",
            "TaxonomyName": "string",
            "SubTaxonomyName": "string",
            "JobLevel": "string",
            "Description": "string",
            "Bullets": [
              {
                "Type": "string",
                "Text": "string"
              }
            ]
          }
        ]
      },
      "SkillsData": [
        {
          "Root": "string",
          "Taxonomies": [
            {
              "Id": "string",
              "Name": "string",
              "PercentOfOverall": 0,
              "SubTaxonomies": [
                {
                  "PercentOfOverall": 0,
                  "PercentOfParent": 0,
                  "SubTaxonomyId": "string",
                  "SubTaxonomyName": "string",
                  "Skills": [
                    {
                      "Id": "string",
                      "Name": "string",
                      "FoundIn": {
                           "SectionType": "string",
                           "Id": "string",
                      },
                      "ExistsInText": true,
                      "Variations": [
                        {
                          "MonthsExperience": {
                            "Value": 0
                          },
                          "LastUsed": {
                            "Value": "2020-11-02"
                          },
                          "Id": "string",
                          "Name": "string",
                          "FoundIn": {
                               "SectionType": "string",
                               "Id": "string",
                           },
                          "ExistsInText": true
                        }
                      ],
                      "MonthsExperience": {
                        "Value": 0
                      },
                      "LastUsed": {
                        "Value": "2020-11-02"
                      },
                      "ChildrenMonthsExperience": {
                        "Value": 0
                      },
                      "ChildrenLastUsed": {
                        "Value": "2020-11-02"
                      }
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "Certifications": [
        {
          "Name": "string",
          "MatchedFromList": true
        }
      ],
      "Licenses": [
        {
          "Name": "string",
          "MatchedFromList": true
        }
      ],
      "Associations": [
        {
          "Organization": "string",
          "Role": "string",
          "FoundInContext": "string"
        }
      ],
      "LanguageCompetencies": [
        {
          "Language": "string",
          "LanguageCode": "string",
          "FoundInContext": "string"
        }
      ],
      "MilitaryExperience": [
        {
          "Country": "string",
          "Service": {
            "Name": "string",
            "Branch": "string",
            "Rank": "string"
          },
          "StartDate": {
            "Date": "2020-11-02",
            "IsCurrentDate": true,
            "FoundYear": true,
            "FoundMonth": true,
            "FoundDay": true
          },
          "EndDate": {
            "Date": "2020-11-02",
            "IsCurrentDate": true,
            "FoundYear": true,
            "FoundMonth": true,
            "FoundDay": true
          },
          "FoundInContext": "string"
        }
      ],
      "SecurityCredentials": [
        {
          "Name": "string",
          "FoundInContext": "string"
        }
      ],
      "References": [
        {
          "ReferenceName": {
            "FormattedName": "string",
            "Prefix": "string",
            "GivenName": "string",
            "Moniker": "string",
            "MiddleName": "string",
            "FamilyName": "string",
            "Suffix": "string"
          },
          "Title": "string",
          "Company": "string",
          "Type": "string",
          "Location": {
            "CountryCode": "string",
            "PostalCode": "string",
            "Regions": [
              "string"
            ],
            "Municipality": "string",
            "StreetAddressLines": [
              "string"
            ],
            "GeoCoordinates": {
              "Latitude": 0,
              "Longitude": 0,
              "Source": "string"
            }
          },
          "Telephones": [
            {
              "Raw": "string",
              "Normalized": "string"
            }
          ],
          "EmailAddresses": [
            "string"
          ],
          "WebAddresses": [
            {
              "Address": "string",
              "Type": "string"
            }
          ]
        }
      ],
      "Achievements": [
        "string"
      ],
      "Training": {
        "Text": "string",
        "Trainings": [
          {
            "Text": "string",
            "Entity": "string",
            "Qualifications": [
              "string"
            ],
            "StartDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            },
            "EndDate": {
              "Date": "2020-11-02",
              "IsCurrentDate": true,
              "FoundYear": true,
              "FoundMonth": true,
              "FoundDay": true
            }
          }
        ]
      },
      "Hobbies": "string",
      "Patents": "string",
      "Publications": "string",
      "SpeakingEngagements": "string",
      "ResumeMetadata": {
        "FoundSections": [
          {
            "FirstLineNumber": 0,
            "LastLineNumber": 0,
            "SectionType": "string",
            "HeaderTextFound": "string"
          }
        ],
        "ResumeQuality": [
          {
            "Level": "string",
            "Findings": [
              {
                "QualityCode": "string",
                "SectionIdentifiers": [
                  {
                    "SectionType": "string",
                    "Id": "string",
                  },
                ],
                "Message": "string"
              }
            ]
          }
        ],
        "ReservedData": {
          "Phones": [
            "string"
          ],
          "Names": [
            "string"
          ],
          "EmailAddresses": [
            "string"
          ],
          "Urls": [
            "string"
          ],
          "OtherData": [
            "string"
          ]
        },
        "PlainText": "string",
        "DocumentLanguage": "string",
        "DocumentCulture": "string",
        "ParserSettings": "string",
        "DocumentLastModified": "2020-11-02",
        "SovrenSignature": [
          "string"
        ]
      },
      "UserDefinedTags": [
        "string"
      ]
    },
    "ConversionMetadata": {
      "DetectedType": "string",
      "SuggestedFileExtension": "string",
      "OutputValidityCode": "string",
      "ElapsedMilliseconds": 0
    },
    "Conversions": {
      "PDF": "string",
      "HTML": "string",
      "RTF": "string",
      "CandidateImage": "string",
      "CandidateImageExtension": "string"
    },
    "ParsingMetadata": {
      "ElapsedMilliseconds": 0,
      "TimedOut": true,
      "TimedOutAtMilliseconds": {
        "Value": 0
      }
    }
  }
}

Parse a Job Order

POST /v10/parser/joborder

Parse a single Job Order.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
This service is designed to parse job orders. It assumes that all files passed to it are job orders. It does not attempt to detect whether a document is a job order 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 order 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 order file.
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.
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Request Body

DocumentAsBase64String required string

A Base64 encoded string of the job order 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.

DocumentLastModified required string

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 optional boolean

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

OutputRtf optional boolean

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

OutputPdf optional boolean

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

Configuration optional object

Options that influence parser behavior.

› Show Child Properties

Configuration.CountryCode optional string

A 2-letter ISO 3166 code (or comma-delimited list of such codes) indicating the country to be assumed in cases where the location cannot be automatically detected. If multiple codes are specified, the first one is given the highest priority.

Configuration.Language optional string

An ISO 639-1 two letter language code indicating the language to be assumed in cases where the language cannot be automatically detected.

Configuration.KnownType optional string

Optionally specify a known type to enable special processing. Possible values include: Indeed, Stride, JOB_SUBMISSION_REPLY_TO_CANDIDATE

Configuration.IncludeRecruitingTerms optional boolean

Recruiting terms in skills and job titles are ignored by default, because these terms often appear in job orders that are unrelated to recruiting. If this job order is for a recruiting or human resources position, then set this to true.

Configuration.IncludeSupplementalText optional boolean

The parser defaults to extracting data from only the text that precedes the place in job orders where they transition from describing the job itself to describing the company, hiring policies, background checks, benefits, etc. This division of text normally works well, but in some job orders it can occur in the wrong place. Set this to true to allow the parser to extract data from all of the text.

Configuration.PreferShorterJobTitles optional boolean

The parser defaults to returning full job titles. Setting this option to true will shorten job titles by excluding trailing phrases that do not include job words, so that "Vice President" would be returned instead of "Vice President, Information Systems".

SkillsData optional string[]

GeocodeOptions optional object

Get or insert geocode coordinate values (latitude/longitude) during the parse transaction.

› Show Child Properties

GeocodeOptions.IncludeGeocoding optional bool

GeocodeOptions.Provider optional string

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.

GeocodeOptions.ProviderKey optional string

The Provider Key for the specified Provider. If using Bing you must specify your own provider key.

GeocodeOptions.PostalAddress optional object

› Show Child Properties

GeocodeOptions.PostalAddress.CountryCode optional string

The ISO 3166-1 alpha-2 code indicating the country for the postal address.

GeocodeOptions.PostalAddress.PostalCode optional string

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

GeocodeOptions.PostalAddress.Region optional string

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

GeocodeOptions.PostalAddress.Municipality optional string

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

GeocodeOptions.PostalAddress.AddressLine optional string

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

GeocodeOptions.GeoCoordinates optional object

› Show Child Properties

IndexingOptions optional object

When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions.

› Show Child Properties

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

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

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

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object

Contains response data for the transaction.

› Show Child Properties

Value.ParsingResponse object

The status of the parse transaction.

› Show Child Properties

Value.GeocodeResponse object

If geocoding was requested in the ParseOptions.GeocodeOptions the status of the geocode transaction will be output here.

› Show Child Properties

Value.IndexingResponse object

If indexing was requested in the ParseOptions.IndexingOptions the status of the index transaction will be output here.

› Show Child Properties

Value.JobData object

The main output from the Sovren Job Parser.

› Show Child Properties

Value.JobData.CurrentJobIsManagement bool

Whether or not the job is a management position. Used by Sovren for AI Matching.

Value.JobData.HighestManagementScore object

The management score, or null. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.ManagementLevel string

The management level. Used by Sovren for AI Matching. One of: { "None", "Low", "Mid", "High"}

Value.JobData.ExecutiveType string

What kind of executive position the job is, if any. Used by Sovren for AI Matching. One of: { "NONE", "ADMIN", "ACCOUNTING", "BUSINESS_DEV", "EXECUTIVE", "FINANCIAL", "GENERAL", "IT", "LEARNING", "MARKETING", "OPERATIONS" }

Value.JobData.MinimumYears object

The minimum years experience for the job, or null. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.MaximumYears object

The maximum years experience for the job, or null. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.MinimumYearsManagement object

The minimum years of management experience, or null. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.MaximumYearsManagement object

The maximum years of management experience, or null. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.RequiredDegree string

The required educational degree, if listed. Used by Sovren for AI Matching.

Value.JobData.StartDate object

The start date for the job, or null.

› Show Child Properties

Value.JobData.EndDate object

The end date for the job, or null.

› Show Child Properties

Value.JobData.BillRate object

The bill rate for the job, if listed.

› Show Child Properties

Value.JobData.PayRate object

The bill rate for the job, if listed.

› Show Child Properties

Value.JobData.JobDescription string

The full job description.

Value.JobData.JobRequirements string

Any requirement listed by the job.

Value.JobData.JobTitles object

The job titles found in the job. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.EmployerNames object

The employer names found in the job.

› Show Child Properties

Value.JobData.Degrees object[]

The educational degrees found listed in the job. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.SchoolNames string[]

Any school names listed in the job.

Value.JobData.CertificationsAndLicenses string[]

Any certifications/licenses listed in the job. Used by Sovren for AI Matching.

Value.JobData.LanguageCodes string[]

Any languages listed in the job. Used by Sovren for AI Matching.

Value.JobData.CurrentLocation object

The location of the job, if listed. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.CurrentLocation.CountryCode string

The 2-letter ISO 3166 country code.

Value.JobData.CurrentLocation.PostalCode string

The Postal or Zip code.

Value.JobData.CurrentLocation.Regions string[]

The Regions/Districts/States.

Value.JobData.CurrentLocation.Municipality string

The City/Municipality/Town.

Value.JobData.CurrentLocation.StreetAddressLines string

Street address lines.

Value.JobData.CurrentLocation.GeoCoordinates object

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

› Show Child Properties

Value.JobData.CurrentLocation.GeoCoordinates.Latitude decimal

The latitude, in degrees.

Value.JobData.CurrentLocation.GeoCoordinates.Longitude decimal

The longitude, in degrees.

Value.JobData.CurrentLocation.GeoCoordinates.Source string

The geocoding source, such as Google or Bing.

Value.JobData.TermsOfInterest string[]

Terms of interest listed in the job.

Value.JobData.Owners string[]

Any owners of the job posting, if listed.

Value.JobData.SkillsData object[]

The skills found in the job. Used by Sovren for AI Matching.

› Show Child Properties

Value.JobData.SkillsData[i].Root string

The name of the skills list that these taxonomies belong to.

Value.JobData.SkillsData[i].Taxonomies object[]

The skills taxonomies found in a resume.

› Show Child Properties

Value.JobData.SkillsData[i].Taxonomies[j].Id string

The id of the skills taxonomy.

Value.JobData.SkillsData[i].Taxonomies[j].Name string

The human-readable name.

Value.JobData.SkillsData[i].Taxonomies[j].PercentOfOverall integer

The percent (0-100) of skills found in the document that belong to this taxonomy.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies object[]

The subtaxonomy children of this taxonomy (more specific groupings of skills).

› Show Child Properties

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].SubTaxonomyId string

The id of the subtaxonomy.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].SubTaxonomyName string

The human-readable name of the subtaxonomy.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].PercentOfOverall integer

The percent (0-100) of skills found in the subtaxonomy compared to all subtaxonomies.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].PercentOfParent integer

The percent (0-100) of skills found in the subtaxonomy compared to other subtaxonomies in the parent taxonomy

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills object[]

The skills from the subtaxonomy that were found.

› Show Child Properties

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Required bool

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

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Id string

The Id of the skill.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Name string

The name of the skill.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].ExistsInText string

Whether or not this skill was found verbatim in the text.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations object[]

The variations (synonyms) of this skill that were found.

› Show Child Properties

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Required bool

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

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Id string

The Id of the skill.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].Name string

The name of the skill.

Value.JobData.SkillsData[i].Taxonomies[j].SubTaxonomies[k].Skills[m].Variations[n].ExistsInText string

Whether or not this skill was found verbatim in the text.

Value.JobData.JobMetadata object

Metadata about the parsed job

› Show Child Properties

Value.JobData.JobMetadata.PlainText string

The plain text that was used for parsing.

Value.JobData.JobMetadata.DocumentLanguage string

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

Value.JobData.JobMetadata.DocumentCulture string

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

Value.JobData.JobMetadata.ParserSettings string

The full parser settings that were used during parsing.

Value.JobData.JobMetadata.DocumentLastModified date

The last-revised/last-modified date that was provided for the document. This was used to calculate all of the important metrics about skills and jobs.

Value.JobData.JobMetadata.SovrenSignature string[]

A digital signature used to ensure there is no tampering between parsing and indexing. This prevents Sovren from storing any PII in the AI Matching engine.

Value.JobData.UserDefinedTags string[]

Value.ConversionMetadata object

Information about converting the document to plain text

› Show Child Properties

Value.ConversionMetadata.DetectedType string

The file type that was detected.

Value.ConversionMetadata.SuggestedFileExtension string

The suggested extension based on the DetectedType.

Value.ConversionMetadata.OutputValidityCode string

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.

Value.ConversionMetadata.ElapsedMilliseconds string

How long the document conversion took, in milliseconds.

Value.Conversions object

Any additional conversions you requested will be here (eg: PDF or HTML).

› Show Child Properties

Value.Conversions.PDF string

If requested by ParseOptions.OutputPdf, this is the document converted to a PDF. This is a byte[] as a Base64-encoded string.

Value.Conversions.HTML string

If requested by ParseOptions.OutputPdf, this is the document converted to HTML.

Value.Conversions.RTF string

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

Value.Conversions.CandidateImage string

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

Value.Conversions.CandidateImageExtension string

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

Value.ParsingMetadata object

Information about the parsing transaction.

› Show Child Properties

Value.ParsingMetadata.ElapsedMilliseconds string

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

Value.ParsingMetadata.TimedOut bool

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

Value.ParsingMetadata.TimedOutAtMilliseconds object

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

› Show Child Properties

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 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",
      "StartDate": {
        "Value": "2020-11-02"
      },
      "EndDate": {
        "Value": "2020-11-02"
      },
      "BillRate": {
        "Amount": 0,
        "Currency": "string",
        "UnitOfTime": "string"
      },
      "PayRate": {
        "Amount": 0,
        "Currency": "string",
        "UnitOfTime": "string"
      },
      "JobDescription": "string",
      "JobRequirements": "string",
      "JobTitles": {
        "MainJobTitle": "string",
        "JobTitle": [
          "string"
        ]
      },
      "EmployerNames": {
        "MainEmployerName": "string",
        "EmployerName": [
          "string"
        ]
      },
      "Degrees": [
        {
          "Name": "string",
          "Type": "string"
        }
      ],
      "SchoolNames": [
        "string"
      ],
      "CertificationsAndLicenses": [
        "string"
      ],
      "LanguageCodes": [
        "string"
      ],
      "CurrentLocation": {
        "CountryCode": "string",
        "PostalCode": "string",
        "Regions": [
          "string"
        ],
        "Municipality": "string",
        "StreetAddressLines": [
          "string"
        ],
        "GeoCoordinates": {
          "Latitude": 0,
          "Longitude": 0,
          "Source": "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",
        "SovrenSignature": [
          "string"
        ]
      },
      "UserDefinedTags": [
        "string"
      ]
    },
    "ParsingResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "GeocodeResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "IndexingResponse": {
      "Code": "Success",
      "Message": "string"
    },
    "ConversionMetadata": {
      "DetectedType": "string",
      "SuggestedFileExtension": "string",
      "OutputValidityCode": "string",
      "ElapsedMilliseconds": 0
    },
    "Conversions": {
      "PDF": "string",
      "HTML": "string",
      "RTF": "string",
      "CandidateImage": "string",
      "CandidateImageExtension": "string"
    },
    "ParsingMetadata": {
      "ElapsedMilliseconds": 0,
      "TimedOut": true,
      "TimedOutAtMilliseconds": {
        "Value": 0
      }
    }
  }
}

Get Account Info

GET /v9/account

Retrieve your account's current information. See Standard Transaction Cost

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
You should only call this endpoint if you are batch parsing, and you should only call it in compliance with our Acceptable Use Policy.

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Value object

Contains response data for the transaction.

› Show Child Properties

{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": {
    "CreditsRemaining": 0,
    "CreditsUsed": 0,
    "MaximumConcurrentRequests": 0,
    "ExpirationDate": ""
  }
}

Create an Index

POST /v10/index/{indexId}

Creates an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id to assign to the new index. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

Request Body

IndexType required string

The type of the index. One of: {"Resume", "Job"}

{
  "IndexType": ""
}

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  }
}

Get All Indexes

GET /v10/index

Retrieves information about all the indexes associated with your account. See Standard Transaction Cost

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
There should never be a need to call this endpoint. You should be keeping track of what indexes you have created and deleted. Adding a document to an index that doesn't exist will return a 404 - Not Found error.

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object[]

Contains response data for the transaction.

› Show Child Properties

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": [
    {
      "OwnerId": "",
      "Name": "",
      "IndexType": ""
    }
  ]
}

Get Index Document Count

GET /v10/index/{indexId}/count

Retrieve the number of documents in a single index. See Standard Transaction Cost

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
There should never be a need to call this endpoint. You control when documents are added/deleted from your indexes, so you should always know how many documents are in any given index.

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id of the index (case-insensitive).

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object

Contains response data for the transaction.

› Show Child Properties

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "Count": 0
}
}

Delete an Index

DELETE /v10/index/{indexId}

Delete an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id of the index to delete (case-insensitive).

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  }
}

Index a Resume

POST /v10/index/{indexId}/resume/{documentId}

Adds a single resume to an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id for the index where the document should be added (case-insensitive).
documentId	string	The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

Request Body

ResumeData required object

Parsed ResumeData from the Sovren Resume Parser. See Parse a Resume

UserDefinedTags optional string[]

The user-defined tags you want the document to have.

{
  "ResumeData": { ... },
  "UserDefinedTags": [
    ""
  ]
}

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  }
}

Index a Job Order

POST /v10/index/{indexId}/joborder/{documentId}

Adds a single job order to an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id for the index where the document should be added (case-insensitive).
documentId	string	The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

Request Body

JobData required object

The parsed JobData from the Sovren Job Order Parser. See Parse a Job Order

UserDefinedTags optional string[]

The user-defined tags you want the document to have.

{
  "JobData": { ... },
  "UserDefinedTags": [
    ""
  ]
}

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  }
}

Index Multiple Resumes

POST /v10/index/{indexId}/resumes

Adds multiple resumes to an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id for the index where the documents should be added (case-insensitive).

Request Body

Resumes object[]

The list of resumes to index.

› Show Child Properties

{
  "Resumes": [
    {
      "DocumentId": "",
      "ResumeData": { ... },
      "UserDefinedTags": [
        ""
      ]
    }
  ]
}

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

SomeErrors – Some items in the bulk request failed

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided

Unauthorized - Your account doesn't have permission to perform this operation

DataNotFound - Data with the specified name wasn't found

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object[]

An array of objects representing the individual document add responses. This is used to determine which documents failed in the event of an error.

› Show Child Properties

Value[i].DocumentId string

Id of the specific document represented in the response

Value[i].Code string

The following is a list of codes that can be returned by the service:

Success – Successful transaction

Error – The specified document had an error during indexing

Value[i].SubCode string

The following is a list of subcodes that can be returned by the service:

Success – Successful transaction

InvalidParameter - A parameter was incorrectly specified

UnhandledException - Unexpected error occurred

Value[i].Message string

This message further describes the code/subcode providing additional detail.

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": [
    {
      "DocumentId": "",
      "Code": "",
      "SubCode": "",
      "Message": ""
    }
  ]
}

Index Multiple Job Orders

POST /v10/index/{indexId}/joborders

Adds multiple job orders to an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
Documents parsed by an account without AI Matching enabled will never be able to be used for matching/searching. For more information on enabling AI Matching reach out to sales@sovren.com

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id for the index where the documents should be added (case-insensitive).

Request Body

Jobs object[]

The list of jobs to index.

› Show Child Properties

{
  "Jobs": [
    {
      "DocumentId": "",
      "JobData": { ... },
      "UserDefinedTags": [
        ""
      ]
    }
  ]
}

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object[]

An array of objects representing the individual document add responses. This is used to determine which documents failed in the event of an error.

› Show Child Properties

Value[i].DocumentId string

Id of the specific document represented in the response

Value[i].Code string

The following is a list of codes that can be returned by the service:

Success – Successful transaction

Error – The specified document had an error during indexing

Value[i].SubCode string

Value[i].Message string

This message further describes the code/subcode providing additional detail.

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": [
    {
      "DocumentId": "",
      "Code": "",
      "SubCode": "",
      "Message": ""
    }
  ]
}

Get a Resume

GET /v10/index/{indexId}/resume/{documentId}

Retrieves a single resume from an index.

Notes

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
There should never be a need to call this endpoint. You should store/retrieve documents in your own database, since documents stored in indexes will have all PII redacted.

Request Headers

It is unnecessary to include these headers when using the Sovren SDK. Your AccountId and ServiceKey will be entered when creating a SovrenClient

Header	Data Type	Required	Description
Sovren-AccountId	string	Yes	The Account ID that is provided to you when establishing your Service Account.
Sovren-ServiceKey	string	Yes	The Service key that is provided to you for access to your account’s available credits.
Content-Type	string	Yes	Indicates the media type of the incoming request body. The only supported value is `application/json`.

Path Parameters

Parameter	Data Type	Description
indexId	string	The id for the index that contains the document (case-insensitive).
documentId	string	The id of the document to retrieve (case-insensitive).

Response Body

Info object

Information explaining the outcome of the transaction.

› Show Child Properties

Info.Code string

Info.Message string

This message further describes the code providing additional detail.

Info.TransactionId string

The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.

Info.EngineVersion string

The version of the parsing/matching engine running under-the-hood.

Info.ApiVersion string

The version of the API.

Info.TotalElapsedMilliseconds string

How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

Info.CustomerDetails object

Information about the customer who made the API call.

› Show Child Properties

Value.CustomerDetails.AccountId string

The AccountId for the account.

Value.CustomerDetails.Name string

The customer name on the account.

Value.CustomerDetails.IPAddress string

The client IP Address where the API call originated.

Value.CustomerDetails.Region string

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

Value.CustomerDetails.CreditsRemaining decimal

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

Value.CustomerDetails.CreditsUsed decimal

The number of credits used by the account.

Value.CustomerDetails.MaximumConcurrentRequests integer

The number of requests that can be made at one time.

Value.CustomerDetails.ExpirationDate date

The date that the current credits expire.

Value object

All of the information extracted while parsing a resume.

› Show Child Properties

Value.ContactInformation object

The candidate's contact information found on the resume.

› Show Child Properties

Value.ContactInformation.CandidateName object

The candidate's name.

› Show Child Properties

Value.ContactInformation.CandidateName.FormattedName string

The name in a standard format.

Value.ContactInformation.CandidateName.Prefix string

A prefix for a name, such as Dr.

Value.ContactInformation.CandidateName.GivenName string

The given (first) name.

Value.ContactInformation.CandidateName.MiddleName string

The middle name or initial.

Value.ContactInformation.CandidateName.FamilyName string

The family (last) name.

Value.ContactInformation.CandidateName.Suffix string

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

Value.ContactInformation.Telephones object[]

The candidate's phone numbers.

› Show Child Properties

Value.ContactInformation.Telephones[i].Raw string

The raw value found in the text.

Value.ContactInformation.Telephones[i].Normalized string

The normalized value.

Value.ContactInformation.Telephones[i].InternationalCountryCode string

The international country code part of the phone number.

Value.ContactInformation.Telephones[i].AreaCityCode string

The area code part of the phone number.

Value.ContactInformation.Telephones[i].SubscriberNumber string

The subscriber number part of the phone number.

Value.ContactInformation.EmailAddresses string[]

The candidate's email addresses.

Value.ContactInformation.Location object

The candidate's location/address

› Show Child Properties

Value.ContactInformation.Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.ContactInformation.Location.PostalCode string

The Postal or Zip code.

Value.ContactInformation.Location.Regions string[]

The Regions/Districts/States.

Value.ContactInformation.Location.Municipality string

The City/Municipality/Town.

Value.ContactInformation.Location.StreetAddressLines string

Street address lines.

Value.ContactInformation.Location.GeoCoordinates object

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

› Show Child Properties

Value.ContactInformation.Location.GeoCoordinates.Latitude decimal

The latitude, in degrees.

Value.ContactInformation.Location.GeoCoordinates.Longitude decimal

The longitude, in degrees.

Value.ContactInformation.Location.GeoCoordinates.Source string

The geocoding source, such as Google or Bing.

Value.ContactInformation.WebAddresses object[]

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

› Show Child Properties

Value.ProfessionalSummary string

The professional summary from the resume.

Value.Objective string

The candidate's written objective.

Value.PersonalAttributes object

Personal information provided by the candidate on the resume.

› Show Child Properties

Value.PersonalAttributes.Availability string

The availability of the candidate.

Value.PersonalAttributes.Birthplace string

The birthplace of the candidate.

Value.PersonalAttributes.CurrentLocation string

The current location listed on the resume.

Value.PersonalAttributes.CurrentSalary object

The current salary listed on the resume.

› Show Child Properties

Value.PersonalAttributes.DateOfBirth object

The date of birth given on the resume

› Show Child Properties

Value.PersonalAttributes.DateOfBirth.Date date

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

Value.PersonalAttributes.DateOfBirth.IsCurrentDate bool

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

Value.PersonalAttributes.DateOfBirth.FoundYear bool

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

Value.PersonalAttributes.DateOfBirth.FoundMonth bool

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

Value.PersonalAttributes.DateOfBirth.FoundDay bool

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

Value.PersonalAttributes.DrivingLicense string

A driving license listed on the resume.

Value.PersonalAttributes.FamilyComposition string

The family composition.

Value.PersonalAttributes.FathersName string

The candidate's father's name listed on the resume.

Value.PersonalAttributes.Gender string

The candidate's gender listed on the resume.

Value.PersonalAttributes.HukouCity string

Used in Chinese resumes.

Value.PersonalAttributes.HukouArea string

Used in Chinese resumes.

Value.PersonalAttributes.MaritalStatus string

The marital status listed on the resume.

Value.PersonalAttributes.MothersMaidenName string

The candidate's mother's maiden name listed on the resume.

Value.PersonalAttributes.MotherTongue string

The candidate's mother tongue (native language) listed on the resume.

Value.PersonalAttributes.NationalIdentities object[]

Any national identities provided on the resume.

› Show Child Properties

Value.PersonalAttributes.Nationality string

The candidate's nationality listed on the resume.

Value.PersonalAttributes.PassportNumber string

The candidate's passport number listed on the resume.

Value.PersonalAttributes.PreferredLocation string

The candidate's preferred location listed on the resume.

Value.PersonalAttributes.RequiredSalary object

The candidate's required salary listed on the resume.

› Show Child Properties

Value.PersonalAttributes.VisaStatus string

The candidate's visa status listed on the resume.

Value.PersonalAttributes.WillingToRelocate string

Whether the candidate is willing to relocate.

Value.Education object

The candidate's education history found on the resume.

› Show Child Properties

Value.Education.HighestDegree object

The highest degree obtained by a candidate

› Show Child Properties

Value.Education.HighestDegree.Name object

The name of the degree

› Show Child Properties

Value.Education.HighestDegree.Type string

The type of degree.

Value.Education.EducationDetails object[]

All of the education details listed on a resume

› Show Child Properties

Value.Education.EducationDetails[i].Id string

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

Value.Education.EducationDetails[i].Text string

The raw text from the resume.

Value.Education.EducationDetails[i].SchoolName object

The name of the school attended

› Show Child Properties

Value.Education.EducationDetails[i].SchoolType string

The type of the school attended. One of: { "UNSPECIFIED", "lowerSchool", "highschool", "secondary", "trade", "professional", "vocational", "community", "college", "university" }

Value.Education.EducationDetails[i].Location object

The Country/Region/City of the school, if found

› Show Child Properties

Value.Education.EducationDetails[i].Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.Education.EducationDetails[i].Location.PostalCode string

The Postal or Zip code.

Value.Education.EducationDetails[i].Location.Regions string[]

The Regions/Districts/States.

Value.Education.EducationDetails[i].Location.Municipality string

The City/Municipality/Town.

Value.Education.EducationDetails[i].Location.StreetAddressLines string

Street address lines

Value.Education.EducationDetails[i].Location.GeoCoordinates object

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

› Show Child Properties

Value.Education.EducationDetails[i].Location.Latitude decimal

The latitude, in degrees.

Value.Education.EducationDetails[i].Location.Longitude decimal

The longitude, in degrees.

Value.Education.EducationDetails[i].Location.Source string

The geocoding source, such as Google or Bing.

Value.Education.EducationDetails[i].Degree object

The degree obtained (or worked toward)

› Show Child Properties

Value.Education.EducationDetails[i].Degree.Name object

The name of the degree

› Show Child Properties

Value.Education.EducationDetails[i].Degree.Type string

The type of degree.

Value.Education.EducationDetails[i].Majors string[]

Any majors/areas of major focus.

Value.Education.EducationDetails[i].Minors string[]

Any minors/areas of minor focus.

Value.Education.EducationDetails[i].GPA object

The GPA/marks listed on the resume

› Show Child Properties

Value.Education.EducationDetails[i].GPA.Score string

The score found in the resume.

Value.Education.EducationDetails[i].GPA.ScoringSystem string

The scoring system used on the resume.

Value.Education.EducationDetails[i].GPA.MaxScore string

The max score in the scoring system.

Value.Education.EducationDetails[i].GPA.MinimumScore string

The minimum score in the scoring system.

Value.Education.EducationDetails[i].GPA.NormalizedScore decimal

The score, normalized to a 0.0-1.0 scale

Value.Education.EducationDetails[i].LastEducationDate object

The date graduated or education ended

› Show Child Properties

Value.Education.EducationDetails[i].Date.Date date

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

Value.Education.EducationDetails[i].Date..IsCurrentDate bool

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

Value.Education.EducationDetails[i].Date.FoundYear bool

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

Value.Education.EducationDetails[i].Date.FoundMonth bool

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

Value.Education.EducationDetails[i].Date.FoundDay bool

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

Value.Education.EducationDetails[i].Graduated object

Whether or not the candidate graduated.

› Show Child Properties

Value.EmploymentHistory object

The candidate's employment/work history found on the resume.

› Show Child Properties

Value.EmploymentHistory.ExperienceSummary string

A summary of all the work history with important calculated metadata

› Show Child Properties

Value.EmploymentHistory.ExperienceSummary.Description string

Value.EmploymentHistory.ExperienceSummary.MonthsOfWorkExperience integer

Value.EmploymentHistory.ExperienceSummary.MonthsOfManagementExperience integer

Value.EmploymentHistory.ExperienceSummary.ExecutiveType string

If ManagementScore is at least 30 (mid-level+), then the job titles are examined to determine the best category for the executive experience. One of: { "NONE", "ADMIN", "ACCOUNTING", "BUSINESS_DEV", "EXECUTIVE", "FINANCIAL", "GENERAL", "IT", "LEARNING", "MARKETING", "OPERATIONS" }

Value.EmploymentHistory.ExperienceSummary.AverageMonthsPerEmployer integer

Value.EmploymentHistory.ExperienceSummary.FulltimeDirectHirePredictiveIndex integer

Value.EmploymentHistory.ExperienceSummary.ManagementStory string

A paragraph of text that summarizes the candidate's management experience (in English).

Value.EmploymentHistory.ExperienceSummary.CurrentManagementLevel string

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" }

Value.EmploymentHistory.ExperienceSummary.ManagementScore integer

Value.EmploymentHistory.Positions object[]

A list of jobs/positions found on the resume.

› Show Child Properties

Value.EmploymentHistory.Positions[i].Id string

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

Value.EmploymentHistory.Positions[i].Employer object

The employer/company for this position. Will be null if IsSelfEmployed is null.

› Show Child Properties

Value.EmploymentHistory.Positions[i].Employer.Name object

The name of the employer (and an accuracy probability).

› Show Child Properties

Value.EmploymentHistory.Positions[i].Employer.NameRaw string

The raw value found in the text.

Value.EmploymentHistory.Positions[i].Employer.NameNormalized string

The normalized value.

Value.EmploymentHistory.Positions[i].Employer.NameProbability string

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

Value.EmploymentHistory.Positions[i].Employer.OtherFoundName object

Sometimes a second possible company name is found, or a department/organization within a company. This is that value, if it is found.

› Show Child Properties

Value.EmploymentHistory.Positions[i].Employer.Location object

The location/address of the employer.

› Show Child Properties

Value.EmploymentHistory.Positions[i].Employer.Location.CountryCode string

The 2-letter ISO 3166 country code.

Value.EmploymentHistory.Positions[i].Employer.Location.PostalCode string

The Postal or Zip code.

Value.EmploymentHistory.Positions[i].Employer.Location.Regions string[]

The Regions/Districts/States.

Value.EmploymentHistory.Positions[i].Employer.Location.Municipality string

The City/Municipality/Town.

Value.EmploymentHistory.Positions[i].Employer.Location.StreetAddressLines string

Street address lines.

Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates object

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

› Show Child Properties

Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Latitude decimal

The latitude, in degrees.

Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Longitude decimal

The longitude, in degrees.

Value.EmploymentHistory.Positions[i].Employer.Location.GeoCoordinates.Source string

The geocoding source, such as Google or Bing.

Value.EmploymentHistory.Positions[i].RelatedToByDates string[]

A list of other positions Ids that have overlapping dates with this Position.

Value.EmploymentHistory.Positions[i].RelatedToByCompanyName string[]

A list of other positions Ids that have the same Employer as this Position.

Value.EmploymentHistory.Positions[i].IsSelfEmployed bool

True if the candidate was self-employed at this job/position.

Value.EmploymentHistory.Positions[i].IsCurrent bool

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

Value.EmploymentHistory.Positions[i].JobTitle object

The job title for this position/job.

› Show Child Properties

Value.EmploymentHistory.Positions[i].Employer.JobTitle.Raw string

The raw text as it was found in the resume.

Value.EmploymentHistory.Positions[i].Employer.JobTitle.Normalized string

The normalized job title.

Value.EmploymentHistory.Positions[i].Employer.JobTitle.Probability string

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

Value.EmploymentHistory.Positions[i].Employer.JobTitle.Variations string[]

Any variations of this job title that might be useful for matching