GET
/
v3
/
resume_search
/
match
Match a single resume and job description
curl --request GET \
  --url https://{region}.affinda.com/v3/resume_search/match \
  --header 'Authorization: Bearer <token>'
{
  "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",
      "value": "<string>",
      "score": 0.68
    }
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Query Parameters

​
resume
string
required

Identify the resume to match.

​
job_description
string
required

Identify the job description to match.

​
index
string

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

​
search_expression
string

Add keywords to the search criteria.

​
job_titles_weight
number

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

Required range: 0 <= x <= 1
​
years_experience_weight
number

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

Required range: 0 <= x <= 1
​
locations_weight
number

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

Required range: 0 <= x <= 1
​
languages_weight
number

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

Required range: 0 <= x <= 1
​
skills_weight
number

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

Required range: 0 <= x <= 1
​
education_weight
number

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

Required range: 0 <= x <= 1
​
search_expression_weight
number

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

Required range: 0 <= x <= 1
​
soc_codes_weight
number

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

Required range: 0 <= x <= 1
​
management_level_weight
number

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

Required range: 0 <= x <= 1

Response

200
application/json

The matching score between the provided resume and job description.

The response is of type object.