Match by Document Id🔗︎
| HTTP Verb | Path |
|---|---|
| POST | /v9/matcher/indexes/(indexId)/documents/(documentId) |
Match a parsed resume/job to resumes/jobs in certain indexes.
Info
- You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
Path Parameters🔗︎
| Parameter | Data Type | Description |
|---|---|---|
| indexId | string | Id of the index that the source document is located in. |
| documentId | string | Id of the document to use as the source for matching (case-insensitive). |
Request Body🔗︎
IndexIdsToSearchInto 🔗︎ string[] required
IndexIdsToSearchInto🔗︎
The ids of the indexes in which you want to find results (case-insensitive).
CategoryWeights 🔗︎ object[]
CategoryWeights🔗︎
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 properties
Settings 🔗︎ object
Settings🔗︎
Options to control variations of job titles.
Settings properties
PositionTitlesMustHaveAnExactMatch 🔗︎ bool
PositionTitlesMustHaveAnExactMatch🔗︎
Set to true to turn off variation matches in job titles.
PositionTitlesIgnoreSingleWordVariations 🔗︎ bool Deprecated
PositionTitlesIgnoreSingleWordVariations🔗︎
Deprecated
NormalizeJobTitles 🔗︎ bool
NormalizeJobTitles🔗︎
Normalize the first three job titles specified in FilterCriteria.JobTitles and automatically include them in the query. Additional charges apply.
You will only benefit from using this parameter if the data in your index was parsed with Professions Normalization enabled.
Normalized job titles help identify more matches by looking beyond the exact job title. Normalization uses lists of synonyms behind the scenes. For example, a search for "HR Advisor" will also return results for "Human Resources Consultant".
When matching, the normalized job title is automatically included in the query if the data in your index was parsed with Professions Normalization enabled.
NormalizeJobTitlesLanguage 🔗︎ string
NormalizeJobTitlesLanguage🔗︎
Specify the language (ISO 639-1 code) of the Job Title to be normalized. This defaults to en. See list of supported languages.
FilterCriteria 🔗︎ object
FilterCriteria🔗︎
Additional criteria for the result set.
FilterCriteria properties
RevisionDateRange 🔗︎ object
RevisionDateRange🔗︎
When specified, the revision date of documents must fall within this range.
RevisionDateRange properties
DocumentIds 🔗︎ string[]
DocumentIds🔗︎
Results must have one of the specified document ids (case-insensitive).
CustomValueIds 🔗︎ string[]
CustomValueIds🔗︎
List of custom value ids. Either all or at least one are required depending on the value of FilterCriteria.CustomValueIdsMustAllExist .
CustomValueIdsMustAllExist 🔗︎ bool
CustomValueIdsMustAllExist🔗︎
When true, all of the custom value ids in FilterCriteria.CustomValueIds must be found. By default, this is false, which means that at least one of the FilterCriteria.CustomValueIds must be found.
LocationCriteria 🔗︎ object[]
LocationCriteria🔗︎
Filter results based on location.
LocationCriteria properties
Locations 🔗︎ object[]
Locations🔗︎
Results must be found within a certain distance of one of the specified locations.
Locations properties
DistanceUnit 🔗︎ string
DistanceUnit🔗︎
The units for the specified distance. One of:
- Miles
- Kilometers
SearchExpression 🔗︎ string
SearchExpression🔗︎
Full-text boolean semantic expresion. For full details on the syntax and supported operations refer to the documentation
HasSecurityCredentials 🔗︎ bool
HasSecurityCredentials🔗︎
If true, results must have/require security credentials. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
SecurityCredentials 🔗︎ string[]
SecurityCredentials🔗︎
Results must have/require at least one of the security credentials specified.
IsPublicSpeaker 🔗︎ bool
IsPublicSpeaker🔗︎
If true, results must have/require public speaking experience.
SchoolNames 🔗︎ string[]
SchoolNames🔗︎
Results must have at least one of the specified school names. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
DegreeNames 🔗︎ string[]
DegreeNames🔗︎
Results must have at least one of the specified degree names. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
DegreeTypes 🔗︎ string[]
DegreeTypes🔗︎
Results must have at least one of the specified degree types. One of the following explicit values as defined by HROpenStandards.org, in increasing order:
- specialeducation
- someHighSchoolOrEquivalent
- ged
- secondary
- highSchoolOrEquivalent
- certification
- vocational
- someCollege
- HND_HNC_OrEquivalent
- associates
- international
- bachelors
- somePostgraduate
- masters
- intermediategraduate
- professional
- postprofessional
- doctorate
- postdoctorate
Employers 🔗︎ string[]
Employers🔗︎
Results must have at least one of the employers in FilterCriteria.Employers. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
EmployersMustAllBeCurrentEmployer 🔗︎ bool
EmployersMustAllBeCurrentEmployer🔗︎
When true, at least one employer in FilterCriteria.Employers must be found in the current time frame.
MonthsExperience 🔗︎ object
MonthsExperience🔗︎
When specified, results total work experieince must fall within this range.
MonthsExperience properties
DocumentLanguages 🔗︎ string[]
DocumentLanguages🔗︎
Results must be written in one of the specified languages.
Skills 🔗︎ object[]
Skills🔗︎
Results must have/require at least one of the specified skills.
Skills properties
SkillName 🔗︎ string
SkillName🔗︎
The name of the skill. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
ExperienceLevel 🔗︎ string
ExperienceLevel🔗︎
The experience level of the skill. Supports the following values:
Low(0-3 years)Mid(4-6 years)High(7+ years)
SkillsMustAllExist 🔗︎ bool
SkillsMustAllExist🔗︎
When true, all of the skills in FilterCriteria.Skills must be found. By default, this is false, which means that at least one of the FilterCriteria.Skills must be found.
IsTopStudent 🔗︎ bool
IsTopStudent🔗︎
Results must have an education with a normalized gpa of .75 or higher (for example, 3.0/4.0 or higher).
JobTitles 🔗︎ object[]
JobTitles🔗︎
Results must have at least one of the specified job titles.
JobTitles properties
Title 🔗︎ string
Title🔗︎
The name of the Job Title. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
ExecutiveType 🔗︎ string[]
ExecutiveType🔗︎
Results must have at least one of the following types of executive:
- None
- Executive
- Admin
- Accounting
- Operations
- Financial
- Marketing
- Business_Dev
- IT
- General
- Learning
Certifications 🔗︎ string[]
Certifications🔗︎
Results must have at least one of the specified certifications. Supports ( *, ? ) wildcard characters after the third character in the term as defined in Special Operators.
MonthsManagementExperience 🔗︎ object
MonthsManagementExperience🔗︎
Results must have the management experience specified in this months range.
MonthsManagementExperience properties
CurrentManagementLevel 🔗︎ string
CurrentManagementLevel🔗︎
Results must currently have at least one of the following management levels:
- None
- Low
- Mid
- High
LanguagesKnown 🔗︎ string[]
LanguagesKnown🔗︎
List of ISO 639-1 codes (lower case, two letters) representing languages known. Either all or at least one are required depending on the value of FilterCriteria.LanguagesKnownMustAllExist.
LanguagesKnownMustAllExist 🔗︎ bool
LanguagesKnownMustAllExist🔗︎
When true, all of the languages in FilterCriteria.LanguagesKnown must be found. By default, this is false, which means that at least one of the FilterCriteria.LanguagesKnown must be found.
Taxonomies 🔗︎ string[]
Taxonomies🔗︎
Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs. A list of our built-in taxonomy IDs can be found here.
AverageMonthsPerEmployer 🔗︎ object
AverageMonthsPerEmployer🔗︎
Results must have an average months per employers specified in this range. Only applicable for resumes; setting this when filtering jobs will cause an error.
AverageMonthsPerEmployer properties
Sample JSON
{
"IndexIdsToSearchInto": [
""
],
"Take": 0,
"CategoryWeights": [
{
"Category": "",
"Weight": 0
}
],
"Settings": {
"PositionTitlesIgnoreSingleWordVariations": false,
"PositionTitlesMustHaveAnExactMatch": false,
"NormalizeJobTitles": false,
"NormalizeJobTitlesLanguage": ""
},
"FilterCriteria": {
"RevisionDateRange": {
"Minimum": "",
"Maximum": ""
},
"DocumentIds": [
""
],
"CustomValueIds": [
""
],
"CustomValueIdsMustAllExist": false,
"LocationCriteria": {
"Locations": [
{
"CountryCode": "",
"Region": "",
"Municipality": "",
"PostalCode": "",
"GeoPoint": {
"Latitude": 0,
"Longitude": 0
}
}
],
"Distance": 0,
"DistanceUnit": "Miles",
"GeocodeProvider": "None",
"GeocodeProviderKey": ""
},
"SearchExpression": "",
"HasPatents": false,
"HasSecurityCredentials": false,
"SecurityCredentials": [
""
],
"IsAuthor": false,
"IsPublicSpeaker": false,
"IsMilitary": false,
"Educations": [
{
"SchoolName": "",
"DegreeMajor": "",
"DegreeName": "",
"DegreeType": "",
"MinimumGPA": 0
}
],
"SchoolNames": [
""
],
"DegreeNames": [
""
],
"DegreeTypes": [
""
],
"Employers": [
""
],
"EmployersMustAllBeCurrentEmployer": false,
"MonthsExperience": {
"Minimum": 0,
"Maximum": 0
},
"DocumentLanguages": [
""
],
"Skills": [
{
"SkillName": "",
"ExperienceLevel": "",
"MonthsOfExperienceRange": {
"Minimum": 0,
"Maximum": 0
},
"IsCurrent": false
}
],
"SkillsMustAllExist": false,
"IsTopStudent": false,
"IsCurrentStudent": false,
"IsRecentGraduate": false,
"JobTitles": [
{
"Title": "",
"IsCurrent": false
}
],
"ExecutiveType": [
""
],
"Certifications": [
""
],
"MonthsManagementExperience": {
"Minimum": 0,
"Maximum": 0
},
"CurrentManagementLevel": "",
"LanguagesKnown": [
""
],
"LanguagesKnownMustAllExist": false,
"Taxonomies": [
""
],
"AverageMonthsPerEmployer": {
"Minimum": 0,
"Maximum": 0
},
"JobPredictiveIndex": {
"Minimum": 0,
"Maximum": 0
}
}
}
Response Body🔗︎
Info 🔗︎ object
Info🔗︎
Information explaining the outcome of the transaction.
Info properties
Code 🔗︎ string
Code🔗︎
| Code | Description |
|---|---|
Success |
Successful transaction |
MissingParameter |
A required parameter wasn't provided |
ConstraintError |
A conditionally 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 |
Couldn't find the requested asset |
Value 🔗︎ object
Value🔗︎
Contains response data for the transaction.
Value properties
Matches 🔗︎ object[]
Matches🔗︎
An object[] containing the results for each match result.
Matches properties
SovScore 🔗︎ integer
SovScore🔗︎
An integer score representing the overall fit of the match. Results are sorted by this parameter in descending order.
EnrichedScoreData 🔗︎ object
EnrichedScoreData🔗︎
Detailed information about the source to target match.
EnrichedScoreData properties
Languages 🔗︎ object
Languages🔗︎
Detailed match information for the Languages category.
Languages properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Certifications 🔗︎ object
Certifications🔗︎
Detailed match information for the Certifications category.
Certifications properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
ExecutiveType 🔗︎ object
ExecutiveType🔗︎
Detailed match information for the ExecutiveType category.
ExecutiveType properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Education 🔗︎ object
Education🔗︎
Detailed match information for the Eduction category.
Education properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Taxonomies 🔗︎ object
Taxonomies🔗︎
Detailed match information for the Taxonomies category.
Taxonomies properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Evidence 🔗︎ object[]
Evidence🔗︎
Detailed written explanation about each data point found or not found.
Evidence properties
ActualTaxonomies 🔗︎ object
ActualTaxonomies🔗︎
Taxonomies found.
ActualTaxonomies properties
Primary 🔗︎ object
Primary🔗︎
Best fit taxonomy evidence.
Primary properties
DesiredTaxonomies 🔗︎ object
DesiredTaxonomies🔗︎
Taxonomies requested.
DesiredTaxonomies properties
Primary 🔗︎ object
Primary🔗︎
Best fit taxonomy evidence.
Primary properties
JobTitles 🔗︎ object
JobTitles🔗︎
Detailed match information for the JobTitles category.
JobTitles properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Evidence 🔗︎ object[]
Evidence🔗︎
Detailed written explanation about each data point found or not found.
Evidence properties
Skills 🔗︎ object
Skills🔗︎
Detailed match information for the Skills category.
Skills properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Evidence 🔗︎ object[]
Evidence🔗︎
Detailed written explanation about each data point found or not found.
Evidence properties
ManagementLevel 🔗︎ object
ManagementLevel🔗︎
Detailed match information for the ManagementLevel category.
ManagementLevel properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
EnrichedRCSScoreData 🔗︎ object
EnrichedRCSScoreData🔗︎
Detailed information about the target to source match.
EnrichedRCSScoreData properties
Languages 🔗︎ object
Languages🔗︎
Detailed match information for the Languages category.
Languages properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Certifications 🔗︎ object
Certifications🔗︎
Detailed match information for the Certifications category.
Certifications properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
ExecutiveType 🔗︎ object
ExecutiveType🔗︎
Detailed match information for the ExecutiveType category.
ExecutiveType properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Education 🔗︎ object
Education🔗︎
Detailed match information for the Eduction category.
Education properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Taxonomies 🔗︎ object
Taxonomies🔗︎
Detailed match information for the Taxonomies category.
Taxonomies properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Evidence 🔗︎ object[]
Evidence🔗︎
Detailed written explanation about each data point found or not found.
Evidence properties
ActualTaxonomies 🔗︎ object
ActualTaxonomies🔗︎
Taxonomies found.
ActualTaxonomies properties
Primary 🔗︎ object
Primary🔗︎
Best fit taxonomy evidence.
Primary properties
DesiredTaxonomies 🔗︎ object
DesiredTaxonomies🔗︎
Taxonomies requested.
DesiredTaxonomies properties
Primary 🔗︎ object
Primary🔗︎
Best fit taxonomy evidence.
Primary properties
JobTitles 🔗︎ object
JobTitles🔗︎
Detailed match information for the JobTitles category.
JobTitles properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Evidence 🔗︎ object[]
Evidence🔗︎
Detailed written explanation about each data point found or not found.
Evidence properties
Skills 🔗︎ object
Skills🔗︎
Detailed match information for the Skills category.
Skills properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
Evidence 🔗︎ object[]
Evidence🔗︎
Detailed written explanation about each data point found or not found.
Evidence properties
ManagementLevel 🔗︎ object
ManagementLevel🔗︎
Detailed match information for the ManagementLevel category.
ManagementLevel properties
UnweightedScore 🔗︎ double
UnweightedScore🔗︎
An unweighted score from 0-100. This is the percentage match of the specified category.
WeightedScore 🔗︎ integer
WeightedScore🔗︎
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.
UnweightedCategoryScores 🔗︎ object[] Deprecated
UnweightedCategoryScores🔗︎
Deprecated
UnweightedCategoryScores properties
ReverseCompatibilityScore 🔗︎ integer
ReverseCompatibilityScore🔗︎
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.
SuggestedCategoryWeights 🔗︎ object[]
SuggestedCategoryWeights🔗︎
An object[] containing our suggested weights for each category based on the source document.
SuggestedCategoryWeights properties
AppliedCategoryWeights 🔗︎ object[]
AppliedCategoryWeights🔗︎
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.
AppliedCategoryWeights properties
CurrentCount 🔗︎ integer
CurrentCount🔗︎
The number of results that were returned. This number will never be greater than the Take in the request.
Sample JSON
{
"Info": {
"Code": "string",
"Message": "string"
},
"Value": {
"Matches": [
{
"Id": "",
"IndexId": "",
"SovScore": 0,
"EnrichedScoreData": {
"Languages": {
"UnweightedScore": 0,
"Found": [
""
],
"NotFound": [
""
],
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"Certifications": {
"UnweightedScore": 0,
"Found": [
""
],
"NotFound": [
""
],
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"ExecutiveType": {
"UnweightedScore": 0,
"Found": [
""
],
"NotFound": [
""
],
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"Education": {
"UnweightedScore": 0,
"ExpectedEducation": "",
"ActualEducation": "",
"Comparison": "",
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"Taxonomies": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"ActualTaxonomies": {
"Primary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
},
"Secondary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
}
},
"DesiredTaxonomies": {
"Primary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
},
"Secondary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
}
}
},
"JobTitles": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"Found": [
{
"RawTerm": "",
"VariationOf": "",
"IsCurrent": false
}
],
"NotFound": [
""
]
},
"Skills": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"Found": [
{
"Skill": "",
"IsCurrent": false
}
],
"NotFound": [
""
]
},
"ManagementLevel": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"Actual": "",
"Desired": "",
"AmountOfExperienceMatches": false
}
},
"EnrichedRCSScoreData": {
"Languages": {
"UnweightedScore": 0,
"Found": [
""
],
"NotFound": [
""
],
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"Certifications": {
"UnweightedScore": 0,
"Found": [
""
],
"NotFound": [
""
],
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"ExecutiveType": {
"UnweightedScore": 0,
"Found": [
""
],
"NotFound": [
""
],
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"Education": {
"UnweightedScore": 0,
"ExpectedEducation": "",
"ActualEducation": "",
"Comparison": "",
"Evidence": [
{
"Fact": "",
"Type": ""
}
]
},
"Taxonomies": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"ActualTaxonomies": {
"Primary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
},
"Secondary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
}
},
"DesiredTaxonomies": {
"Primary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
},
"Secondary": {
"Taxonomy": {
"Name": "",
"Id": "",
"Matched": false
},
"SubTaxnomy": {
"Name": "",
"Id": "",
"Matched": false
}
}
}
},
"JobTitles": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"Found": [
{
"RawTerm": "",
"VariationOf": "",
"IsCurrent": false
}
],
"NotFound": [
""
]
},
"Skills": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"Found": [
{
"Skill": "",
"IsCurrent": false
}
],
"NotFound": [
""
]
},
"ManagementLevel": {
"UnweightedScore": 0,
"Evidence": [
{
"Fact": "",
"Type": ""
}
],
"Actual": "",
"Desired": "",
"AmountOfExperienceMatches": false
}
},
"WeightedScore": 0,
"UnweightedCategoryScores": [
{
"Category": "",
"UnweightedScore": 0,
"TermsFound": [
""
]
}
],
"ReverseCompatibilityScore": 0
}
],
"SuggestedCategoryWeights": [
{
"Category": "",
"Weight": 0
}
],
"AppliedCategoryWeights": [
{
"Category": "",
"Weight": 0
}
],
"CreditsRemaining": 0,
"CurrentCount": 0,
"TotalCount": 0,
"ElapsedMilliseconds": 0
}
}