Skip to main
Group
Free TrialCTA Arrow
Why Sovren?
Products
Group 15
Resume Parser
Parse resume and job orders with control, accuracy and speed.
Group 15
+AI Matching
Match with an engine that mimics your thinking.
PricingResourcesCompany

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Group 6
SaaS     |
Getting Started
First Steps
Sovren SDK
Code Samples
Standard Transaction Cost
Endpoints
Authentication
Versioning
HTTP Status Codes
Resume Parser Overview
Document Last Modified Date
Batch Parsing Concurrency
How Does Resume Parsing Work
Documents That Can Cause Problems
Entry Level
Australia
Config String Builder
Parser Output Settings
Additional Settings
Searching
Sort Order
Matching
Scores
Filtering
Semantic Filter
Full-text Filter
Boolean Syntax
Special Operators
Semantic Expressions
Feature Comparison
UI Overview
Authentication
UI Customization
Hooks
Getting Started
Rate Limits
Skills
Supported Languages
About the Skills Taxonomy
Professions
Supported Taxonomies
Supported Languages
Ontology
Supported Languages
API Technical SpecsPoliciesFAQsDocumentsRelease Notes

Score Documents to a Job

POST /v10/scorer/bimetric/joborder

Score a group of resumes/job orders (that aren't indexed) to a parsed job. It's highly recommended to index all of your documents and leverage the speed and power of the AI Matching Engine and use one of the AI Match endpoints. This will also reduce your overall cost as the bimetric scoring is a higher charge per transaction.

Request Body

SourceJobrequiredobject
Parsed job order to match against each of the target documents.
SourceJob.Idrequiredstring
Id of the source document. This isn't used in any calculation, only to assist in displaying output.
SourceJob.JobDatarequiredstring
The parsed JobData from the Sovren Job Order Parser. See Parse a Job Order
TargetJobsoptionalobject[]
Array of parsed job orders to be matched against the source resume.
TargetJobs[i].Idrequiredstring
Id of the target job order. This isn't used in any calculation, only to assist in displaying output.
TargetJobs[i].JobDatarequiredobject
The parsed JobData from the Sovren Job Order Parser. See Parse a Job Order
TargetResumesoptionalobject[]
Array of parsed resumes to be matched against the source resume.
TargetResumes[i].Idrequiredstring
Id of the target job order. This isn't used in any calculation, only to assist in displaying output.
TargetResumes[i].ResumeDatarequiredobject
Parsed ResumeData from the Sovren Resume Parser. See Parse a Resume
Settingsoptionalobject
Options to control variations of job titles.
Settings.PositionTitlesMustHaveAnExactMatchoptionalbool
Set to true to turn off variation matches in job titles.
PreferredCategoryWeightsobject
The weights you want to use for scoring.It is important to specify these, otherwise default values will be used.

These weights will be used except in the case that you provided a non-zero weight for a category that is irrelevant in the source document. For example, this can happen when the source document contains no languages.
PreferredCategoryWeights.Educationdecimal
The weight of the Education category relative to other categories.
PreferredCategoryWeights.JobTitlesdecimal
The weight of the JobTitles category relative to other categories..
PreferredCategoryWeights.Skillsdecimal
The weight of the Skills category relative to other categories.
PreferredCategoryWeights.Industriesdecimal
The weight of the Industries/Taxonomies category relative to other categories.
PreferredCategoryWeights.Languagesdecimal
The weight of the Languages category relative to other categories.
PreferredCategoryWeights.Certificationsdecimal
The weight of the Certifications category relative to other categories.
PreferredCategoryWeights.ExecutiveTypedecimal
The weight of the ExecutiveType category relative to other categories.
PreferredCategoryWeights.ManagementLeveldecimal
The weight of the ManagementLevel category relative to other categories..

Sample Request

{ ... 
{ ... 
"Id" :  "","JobData" :  "..."},[ ... 
{
"Id" :  "","ResumeData" :  "..."}],[ ... 
{
"Id" :  "","JobData" :  "..."}],{ ... 
"PositionTitlesMustHaveAnExactMatch" :  false},{ ... 
"Education" :  0,"JobTitles" :  0,"Skills" :  0,"Industries" :  0,"Languages" :  0,"Certifications" :  0,"ExecutiveType" :  0,"ManagementLevel" :  0}}

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codeobject[]
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.Messageobject[]
This message further describes the code providing additional detail.
Info.TransactionIdstring
The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.
Info.EngineVersionstring
The version of the parsing/matching engine running under-the-hood.
Info.ApiVersionstring
The version of the API.
Info.TotalElapsedMillisecondsinteger
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.TransactionCostdecimal
How many credits the transaction costs.How many credits the transaction costs.
Info.CustomerDetailsobject
Information about the customer who made the API call.
Value.CustomerDetails.AccountIdstring
The AccountId for the account.
Value.CustomerDetails.Namestring
The customer name on the account.
Value.CustomerDetails.IPAddressstring
The client IP Address where the API call originated.
Value.CustomerDetails.Regionstring
The region for the account, also known as the 'Data Center'.
Value.CustomerDetails.CreditsRemainingdecimal
The number of credits remaining to be used by the account.
Value.CustomerDetails.CreditsUseddecimal
The number of credits used by the account.
Value.CustomerDetails.MaximumConcurrentRequestsinteger
The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
Valueobject
Contains response data for the transaction.
Value.Matchesobject[]
An object[] containing the results for each match result.
Value.Matches[i].Idstring
Id of the matched document in the index.
Value.Matches[i].SovScoreinteger
An integer score representing the overall fit of the match. Results are sorted by this parameter in descending order.
Value.Matches[i].EnrichedScoreDataobject
Detailed information about the source to target match.
Value.Matches[i].EnrichedScoreData.Languagesobject
Detailed match information for the Languages category.
Value.Matches[i].EnrichedScoreData.Languages.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.Languages.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.Languages.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.Languages.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.Languages.Foundstring[]
Array of terms found in both documents.
Value.Matches[i].EnrichedScoreData.Languages.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedScoreData.Certificationsobject
Detailed match information for the Certifications category.
Value.Matches[i].EnrichedScoreData.Certifications.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.Certifications.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.Certifications.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.Certifications.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.Certifications.Foundstring[]
Array of terms found in both documents.
Value.Matches[i].EnrichedScoreData.Certifications.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedScoreData.ExecutiveTypeobject
Detailed match information for the ExecutiveType category.
Value.Matches[i].EnrichedScoreData.ExecutiveType.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.ExecutiveType.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.ExecutiveType.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.ExecutiveType.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.ExecutiveType.Foundstring[]
Array of terms found in both documents.
Value.Matches[i].EnrichedScoreData.ExecutiveType.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedScoreData.Educationobject
Detailed match information for the Eduction category.
Value.Matches[i].EnrichedScoreData.Education.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.Education.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.Education.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.Education.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.Education.ExpectedEducationstring
Requested level of education.
Value.Matches[i].EnrichedScoreData.Education.ActualEducationstring
Actual level of education found.
Value.Matches[i].EnrichedScoreData.Education.Comparisonstring
Description of the relationship of ExpectedEducation and ActualEducation. This provides an easier value to key off of. Possible values are:
  • DoesNotMeetExpected
  • MeetsExpected
  • ExceedsExpected
Value.Matches[i].EnrichedScoreData.Taxonomiesobject
Detailed match information for the Taxonomies category.
Value.Matches[i].EnrichedScoreData.Taxonomies.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.Taxonomies.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.Taxonomies.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.Taxonomies.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomiesobject
Taxonomies found.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primaryobject
Best fit taxonomy evidence.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomyobject
Best fit parent taxonomy.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomyobject
Best fit sub-taxonomy
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Secondaryobject
Second best fit taxonomy evidence.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Secondary.Taxonomyobject
Second best fit parent taxonomy.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Secondary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Secondary.Subtaxonomyobject
Second best fit sub-taxonomy.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomiesobject
Taxonomies requested.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primaryobject
Best fit taxonomy evidence.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomyobject
Best fit parent taxonomy.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomyobject
Best fit sub-taxonomy
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Secondaryobject
Second best fit taxonomy evidence.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Secondary.Taxonomyobject
Second best fit parent taxonomy.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Secondary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Secondary.Subtaxonomyobject
Second best fit sub-taxonomy.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedScoreData.JobTitlesobject
Detailed match information for the JobTitles category.
Value.Matches[i].EnrichedScoreData.JobTitles.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.JobTitles.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.JobTitles.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.JobTitles.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.JobTitles.Foundstring[]
Array of Job Titles found in both documents.
Value.Matches[i].EnrichedScoreData.JobTitles.Found[j].RawTermstring
Exact term found.
Value.Matches[i].EnrichedScoreData.JobTitles.Found[j].VariationOfstring
Original term that the variation was derived from.
Value.Matches[i].EnrichedScoreData.JobTitles.Found[j].IsCurrentbool
True when the Job Title found is in the current time-frame.
Value.Matches[i].EnrichedScoreData.JobTitles.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedScoreData.Skillsobject
Detailed match information for the Skills category.
Value.Matches[i].EnrichedScoreData.Skills.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.Skills.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.Skills.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.Skills.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.Skills.Foundstring[]
Array of Skills found in both documents.
Value.Matches[i].EnrichedScoreData.Skills.Found[j].Skillstring
Name of the skill.
Value.Matches[i].EnrichedScoreData.Skills.Found[j].IsCurrentbool
True when the skill is found in the current time-frame.
Value.Matches[i].EnrichedScoreData.Skills.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedScoreData.ManagementLevelobject
Detailed match information for the ManagementLevel category.
Value.Matches[i].EnrichedScoreData.ManagementLevel.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedScoreData.ManagementLevel.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedScoreData.ManagementLevel.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedScoreData.ManagementLevel.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedScoreData.ManagementLevel.Actualstring
Actual management level found.
Value.Matches[i].EnrichedScoreData.ManagementLevel.Desiredstring
Requested management level.
Value.Matches[i].EnrichedScoreData.ManagementLevel.AmountOfExperienceMatchesbool
True when the duration of management level matches in the two documents.
Value.Matches[i].EnrichedRCSScoreDataobject
Detailed information about the target to source match.
Value.Matches[i].EnrichedRCSScoreData.Languagesobject
Detailed match information for the Languages category.
Value.Matches[i].EnrichedRCSScoreData.Languages.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.Languages.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.Languages.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.Languages.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.Languages.Foundstring[]
Array of terms found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Languages.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedRCSScoreData.Certificationsobject
Detailed match information for the Certifications category.
Value.Matches[i].EnrichedRCSScoreData.Certifications.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.Certifications.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.Certifications.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.Certifications.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.Certifications.Foundstring[]
Array of terms found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Certifications.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedRCSScoreData.ExecutiveTypeobject
Detailed match information for the ExecutiveType category.
Value.Matches[i].EnrichedRCSScoreData.ExecutiveType.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.ExecutiveType.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.ExecutiveType.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.ExecutiveType.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.ExecutiveType.Foundstring[]
Array of terms found in both documents.
Value.Matches[i].EnrichedRCSScoreData.ExecutiveType.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedRCSScoreData.Educationobject
Detailed match information for the Eduction category.
Value.Matches[i].EnrichedRCSScoreData.Education.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.Education.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.Education.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.Education.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.Education.ExpectedEducationstring
Requested level of education.
Value.Matches[i].EnrichedRCSScoreData.Education.ActualEducationstring
Actual level of education found.
Value.Matches[i].EnrichedRCSScoreData.Education.Comparisonstring
Description of the relationship of ExpectedEducation and ActualEducation. This provides an easier value to key off of. Possible values are:
  • DoesNotMeetExpected
  • MeetsExpected
  • ExceedsExpected
Value.Matches[i].EnrichedRCSScoreData.Taxonomiesobject
Detailed match information for the Taxonomies category.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomiesobject
Taxonomies found.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primaryobject
Best fit taxonomy evidence.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomyobject
Best fit parent taxonomy.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomyobject
Best fit sub-taxonomy
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Secondaryobject
Second best fit taxonomy evidence.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Secondary.Taxonomyobject
Second best fit parent taxonomy.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Secondary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Secondary.Subtaxonomyobject
Second best fit sub-taxonomy.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.ActualTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomiesobject
Taxonomies requested.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primaryobject
Best fit taxonomy evidence.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomyobject
Best fit parent taxonomy.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomyobject
Best fit sub-taxonomy
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Secondaryobject
Second best fit taxonomy evidence.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Secondary.Taxonomyobject
Second best fit parent taxonomy.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Secondary.Taxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Taxonomy.Matchedbool
True when this parent taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Secondary.Subtaxonomyobject
Second best fit sub-taxonomy.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Namestring
Taxonomy name.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Idstring
Taxonomy id.
Value.Matches[i].EnrichedRCSScoreData.Taxonomies.DesiredTaxonomies.Primary.Subtaxonomy.Matchedbool
True when this sub taxonomy value is found in both documents.
Value.Matches[i].EnrichedRCSScoreData.JobTitlesobject
Detailed match information for the JobTitles category.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Foundstring[]
Array of Job Titles found in both documents.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Found[j].RawTermstring
Exact term found.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Found[j].VariationOfstring
Original term that the variation was derived from.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.Found[j].IsCurrentbool
True when the Job Title found is in the current time-frame.
Value.Matches[i].EnrichedRCSScoreData.JobTitles.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedRCSScoreData.Skillsobject
Detailed match information for the Skills category.
Value.Matches[i].EnrichedRCSScoreData.Skills.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.Skills.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.Skills.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.Skills.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.Skills.Foundstring[]
Array of Skills found in both documents.
Value.Matches[i].EnrichedRCSScoreData.Skills.Found[j].Skillstring
Name of the skill.
Value.Matches[i].EnrichedRCSScoreData.Skills.Found[j].IsCurrentbool
True when the skill is found in the current time-frame.
Value.Matches[i].EnrichedRCSScoreData.Skills.NotFoundstring[]
Array of terms requested, but not found.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevelobject
Detailed match information for the ManagementLevel category.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.UnweightedScoredouble
An unweighted score from 0-100. This is the percentage match of the specified category.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.Evidenceobject[]
Detailed written explanation about each data point found or not found.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.Evidence[j].Factstring
Information regarding the outcome of one or more of the data points in the query.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.Evidence[j].Typestring
Type of evidence message. Possible values include:
  • Negative
  • Mixed
  • Positive
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.Actualstring
Actual management level found.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.Desiredstring
Requested management level.
Value.Matches[i].EnrichedRCSScoreData.ManagementLevel.AmountOfExperienceMatchesbool
True when the duration of management level matches in the two documents.
Value.Matches[i].WeightedScoreinteger
An integer score from 0-100 representing how well the source document matched the current document. This calculation is the sum of the unweighted category scores multiplied by their respective suggested weight.
Value.Matches[i].UnweightedCategoryScoresobject[]
Deprecated
Value.Matches[i].UnweightedCategoryScores[i].Categorystring
Deprecated
Value.Matches[i].UnweightedCategoryScores[i].UnweightedScoredecimal
Deprecated
Value.Matches[i].UnweightedCategoryScores[i].TermsFoundstring[]
Deprecated
Value.Matches[i].ReverseCompatibilityScoreinteger
An integer score from 0-100 which represents how well the target document matched to the source document. This isn't the same as WeightedScore because when doing the reverse calculation we are analyzing for all of the data from the target document to be found in the source document.
Value.SuggestedCategoryWeightsobject
The weights suggested by Sovren based solely on the data in the source document.

NOTE: these should only be used as a fallback or initial value. Your system/users should have the ability to adjust/override these (in the PreferredCategoryWeights in the request)
Value.SuggestedCategoryWeights.Educationdecimal
The weight of the Education category relative to other categories.
Value.SuggestedCategoryWeights.JobTitlesdecimal
The weight of the JobTitles category relative to other categories..
Value.SuggestedCategoryWeights.Skillsdecimal
The weight of the Skills category relative to other categories.
Value.SuggestedCategoryWeights.Industriesdecimal
The weight of the Industries/Taxonomies category relative to other categories.
Value.SuggestedCategoryWeights.Languagesdecimal
The weight of the Languages category relative to other categories.
Value.SuggestedCategoryWeights.Certificationsdecimal
The weight of the Certifications category relative to other categories.
Value.SuggestedCategoryWeights.ExecutiveTypedecimal
The weight of the ExecutiveType category relative to other categories.
Value.SuggestedCategoryWeights.ManagementLeveldecimal
The weight of the ManagementLevel category relative to other categories.
Value.SuggestedCategoryWeights.EducationHasDataboolean
If false, the Education category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.JobTitlesHasDataboolean
If false, the JobTitles category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.SkillsHasDataboolean
If false, the Skills category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.IndustriesHasDataboolean
If false, the Industries/Taxonomies category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.LanguagesHasDataboolean
If false, the Languages category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.CertificationsHasDataboolean
If false, the Certifications category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.ExecutiveTypeHasDataboolean
If false, the ExecutiveType category has no data and should be ignored/hidden.
Value.SuggestedCategoryWeights.ManagementLevelHasDataboolean
If false, the ManagementLevel category has no data and should be ignored/hidden.
Value.AppliedCategoryWeightsobject
The weights that were actually used for scoring. These are either

1) if the PreferredCategoryWeights are specified in the request, these are used (with any adjustments for non-applicable categories)
2) otherwise these are simply the SuggestedCategoryWeights
Value.AppliedCategoryWeights.Educationdecimal
The weight of the Education category relative to other categories.
Value.AppliedCategoryWeights.JobTitlesdecimal
The weight of the JobTitles category relative to other categories..
Value.AppliedCategoryWeights.Skillsdecimal
The weight of the Skills category relative to other categories.
Value.AppliedCategoryWeights.Industriesdecimal
The weight of the Industries/Taxonomies category relative to other categories.
Value.AppliedCategoryWeights.Languagesdecimal
The weight of the Languages category relative to other categories.
Value.AppliedCategoryWeights.Certificationsdecimal
The weight of the Certifications category relative to other categories.
Value.AppliedCategoryWeights.ExecutiveTypedecimal
The weight of the ExecutiveType category relative to other categories.
Value.AppliedCategoryWeights.ManagementLeveldecimal
The weight of the ManagementLevel category relative to other categories..

Sample Response

{ ... 
{ ... 
"Code" :  "string","Message" :  "string","TransactionId" :  "string","EngineVersion" :  "string","ApiVersion" :  "string","TotalElapsedMilliseconds" :  0,"TransactionCost" :  0,{ ... 
"AccountId" :  "string","Name" :  "string","IPAddress" :  "string","Region" :  "string","CreditsRemaining" :  0,"CreditsUsed" :  0,"ExpirationDate" :  "2021-12-31","MaximumConcurrentRequests" :  0}},{ ... 
[ ... 
{
"Id" :  "","SovScore" :  0,{ ... 
{ ... 
"UnweightedScore" :  0,[ ... 
""],[ ... 
""],[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,[ ... 
""],[ ... 
""],[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,[ ... 
""],[ ... 
""],[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,"ExpectedEducation" :  "","ActualEducation" :  "","Comparison" :  "",[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],{ ... 
{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}},{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}}},{ ... 
{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}},{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}}}},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],[ ... 
{
"RawTerm" :  "","VariationOf" :  "","IsCurrent" :  false}],[ ... 
""]},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],[ ... 
{
"Skill" :  "","IsCurrent" :  false}],[ ... 
""]},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],"Actual" :  "","Desired" :  "","AmountOfExperienceMatches" :  false}},{ ... 
{ ... 
"UnweightedScore" :  0,[ ... 
""],[ ... 
""],[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,[ ... 
""],[ ... 
""],[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,[ ... 
""],[ ... 
""],[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,"ExpectedEducation" :  "","ActualEducation" :  "","Comparison" :  "",[ ... 
{
"Fact" :  "","Type" :  ""}]},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],{ ... 
{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}},{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}}},{ ... 
{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}},{ ... 
{ ... 
"Name" :  "","Id" :  "","Matched" :  false},{ ... 
"Name" :  "","Id" :  "","Matched" :  false}}}},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],[ ... 
{
"RawTerm" :  "","VariationOf" :  "","IsCurrent" :  false}],[ ... 
""]},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],[ ... 
{
"Skill" :  "","IsCurrent" :  false}],[ ... 
""]},{ ... 
"UnweightedScore" :  0,[ ... 
{
"Fact" :  "","Type" :  ""}],"Actual" :  "","Desired" :  "","AmountOfExperienceMatches" :  false}},"WeightedScore" :  0,[ ... 
{
"Category" :  "","UnweightedScore" :  0,[ ... 
""]}],"ReverseCompatibilityScore" :  0}],{ ... 
"Education" :  0,"JobTitles" :  0,"Skills" :  0,"Industries" :  0,"Languages" :  0,"Certifications" :  0,"ExecutiveType" :  0,"ManagementLevel" :  0,"EducationHasData" :  false,"JobTitlesHasData" :  false,"SkillsHasData" :  false,"IndustriesHasData" :  false,"LanguagesHasData" :  false,"CertificationsHasData" :  false,"ExecutiveTypeHasData" :  false,"ManagementLevelHasData" :  false},{ ... 
"Education" :  0,"JobTitles" :  0,"Skills" :  0,"Industries" :  0,"Languages" :  0,"Certifications" :  0,"ExecutiveType" :  0,"ManagementLevel" :  0}}}
SOC II Type 2
Compliant
Why Sovren?
Company
Pricing
Account Login
Have questions? We can help.
© 2023 Textkernel US LLC. All rights reserved.
Privacy Policy | Terms of Service | GDPR