Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Score a Set of Documents

POST /v9/scorer/bimetric

Score a parsed resume/job order to a group of resumes/job orders that aren't indexed. 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.

Notes

Request Body

SourceDocumentrequiredobject
Parsed document to match against each of the target documents.
SourceDocument.Idrequiredstring
Id of the source document. This isn't used in any calculation, only to assist in displaying output.
SourceDocument.FileTextrequiredstring
Parsed JSON from the Sovren Resume or Job Order Parser.
TargetDocumentsrequiredobject[]
Array of parsed documents to be matched against the source document.
TargetDocuments[i].Idrequiredstring
Id of the target document. This isn't used in any calculation, only to assist in displaying output.
TargetDocuments[i].FileTextrequiredstring
Parsed JSON from the Sovren Resume or Job Order Parser
Settingsrequiredobject
Options to control variations of job titles.
Settings.PositionTitlesMustHaveAnExactMatchrequiredbool
Set to true to turn off variation matches in job titles.
Settings.PositionTitlesIgnoreSingleWordVariationsrequiredbool
Set to true to ignore single-word variations of multi-word job titles.
CategoryWeightsrequiredobject[]
List of categories with weights that determine how the WeightedScore is calculated. It's important to specify these before the match so the query returns the top results using these weights. Only the categories included in this list will be used to calculate the WeightedScore.
CategoryWeights.Categoryrequiredstring
The name of the category. One of:
  • EDUCATION
  • JOB_TITLES
  • SKILLS
  • INDUSTRIES
  • LANGUAGES
  • CERTIFICATIONS
  • EXECUTIVE_TYPE
  • MANAGEMENT_LEVEL
CategoryWeights.Weightrequireddecimal
The weight of the category relative to other categories. It's recommended for the specified categories to add up to 1, so it's obvious how the percentages are applied.

Sample Request

{ ... 
{ ... 
Id :  "",FileText :  "",
},
[ ... 
{
Id :  "",FileText :  "",
},
],
{ ... 
PositionTitlesMustHaveAnExactMatch :  false,PositionTitlesIgnoreSingleWordVariations :  false,
},
[ ... 
{
Category :  "",Weight :  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.
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[]
An object[] containing our suggested weights for each category based on the source document.
Value.SuggestedCategoryWeights.Categorystring
Name of the category.
Value.SuggestedCategoryWeights.Weightdecimal
A 0-100 weight of suggested importance for the speficied category. This is calculated from the data in the source document. A sum of all of the SuggestedCategoryWeights will equal 100.
Value.AppliedCategoryWeightsobject[]
An object[] containing the weights that were used for each category based on a combination of the data in the source document and any desired weights passed in the request.
Value.AppliedCategoryWeights[i].Categorystring
Name of the category.
Value.AppliedCategoryWeights[i].Weightdecimal
A 0-100 weight of suggested importance for the speficied category. This is calculated from the data in the source document combined with any desired weights passed in the request. A sum of all of the AppliedCategoryWeights will equal 100.
Value.CreditsRemainingdecimal
The number of remaining credits is returned with every response. Please ensure that you set up monitoring of this value to ensure that you don't experience an outage by letting your credits reach 0.

Sample Response

{ ... 
{ ... 
Code :  "",Message :  "",
},
{ ... 
[ ... 
{
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,
},
],
[ ... 
{
Category :  "",Weight :  0,
},
],
[ ... 
{
Category :  "",Weight :  0,
},
],
CreditsRemaining :  0,
},
}