Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Search & Match - Searching

Get search result of specific resume

This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The identifier is the unique ID returned via the /resume_search endpoint.

post/v2/resume_search/details/{identifier}

Path parameters

identifierstring required
Example:ELglqBbT

Resume identifier

Request body

indicesstring[] required
jobDescriptionstring

A random string that uniquely identify the resource.

resumestring

A random string that uniquely identify the resource.

jobTitlesstring[]
jobTitlesCurrentOnlyboolean

Search only through the canditate's current job

jobTitlesRequiredboolean
jobTitlesWeightnumber
yearsExperienceMininteger nullable

Minimum years of total work experience

yearsExperienceMaxinteger nullable

Maximum years of total work experience

yearsExperienceRequiredboolean
yearsExperienceWeightnumber
locationsWeightnumber
locationsRequiredboolean
skillsWeightnumber
languagesWeightnumber
institutionsstring[]
institutionsRequiredboolean
degreesstring[]
degreesRequiredboolean
highestDegreeTypesEducationLevel[]
highestDegreeTypesRequiredboolean
isCurrentStudentboolean

Search for student canditates

isCurrentStudentRequiredboolean
isRecentGraduateboolean

Search for canditates that graduated less than a year ago

isRecentGraduateRequiredboolean
educationWeightnumber
searchExpressionstring nullable

Search through resumes' raw text

searchExpressionRequiredboolean
searchExpressionWeightnumber
socCodesinteger[]
socCodesWeightnumber
socCodesRequiredboolean
managementLevel'None' | 'Low' | 'Mid' | 'Upper' nullable
managementLevelRequiredboolean
managementLevelWeightnumber

Example request

{
  "indices": [
    "all-resumes"
  ],
  "highestDegreeTypes": [
    "bachelors"
  ],
  "managementLevel": "Low",
  "customData": [
    {
      "filterType": "equals",
      "dataPoint": "isAvailable",
      "field": "isAvailable",
      "query": {
        "value": true
      }
    }
  ]
}

Response

Successfully retrieved detail search result.