Sign in

v1

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

Match a single resume and job description

Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match.<br/> Note, this score will not directly match the score returned from POST /resume_search/details/{identifier}.

get/v2/resume_search/match

Query parameters

resumestring required

Identify the resume to match.

job_descriptionstring required

Identify the job description to match.

indexstring

Optionally, specify an index to search in. If not specified, will search in all indexes.

search_expressionstring

Add keywords to the search criteria.

job_titles_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

years_experience_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

locations_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

languages_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

skills_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

education_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

search_expression_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

soc_codes_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

management_level_weightnumber

How important is this criteria to the matching score, range from 0 to 1.

Response

The matching score between the provided resume and job description.

scorenumber

The matching score between the provided resume and job description.

Example response

{
  "score": 0.75,
  "details": {
    "jobTitle": {
      "value": "Software Developer",
      "label": "Job Title",
      "score": 0.68
    },
    "managementLevel": {
      "value": "Low",
      "label": "Management level",
      "score": 0.68
    },
    "experience": {
      "value": "2.0 - 3.0 years",
      "label": "Experience",
      "score": 0.68
    },
    "skills": {
      "value": "Python (Programming Language), Software Development",
      "label": "Skills",
      "score": 0.68
    },
    "languages": {
      "value": "English",
      "label": "Languages",
      "score": 0.68
    },
    "location": {
      "value": "Roxburgh Park, Australia",
      "label": "Location",
      "score": 0.68
    },
    "education": {
      "value": "Architecture Interior Design",
      "label": "Education",
      "score": 0.68
    },
    "occupationGroup": {
      "value": "Programmers and software development professionals",
      "label": "Occupation group",
      "score": 0.68
    },
    "searchExpression": {
      "label": "Search expression",
      "score": 0.68
    }
  }
}