Sign in

v1

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

Search through parsed resumes

Searches through parsed resumes. Users have 3 options to create a search:<br /><br /> 1. Match to a job description - a parsed job description is used to find candidates that suit it<br /> 2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes<br /> 3. Search using custom criteria<br /><br /> Users should only populate 1 of jobDescription, resume or the custom criteria.

post/v2/resume_search

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger
Example:20

The numbers of results to return.

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

Will return matching documents

countinteger

Total number of results

nextstring nullable

URL to request next page of results

previousstring nullable

URL to request previous page of results

Example response

{
  "count": 130,
  "next": "https://api.affinda.com/v3/documents?limit=300&offset=300",
  "previous": "https://api.affinda.com/v3/documents?limit=300",
  "parameters": {
    "indices": [
      "all-resumes"
    ],
    "highestDegreeTypes": [
      "bachelors"
    ],
    "managementLevel": "Low",
    "customData": [
      {
        "filterType": "equals",
        "dataPoint": "isAvailable",
        "field": "isAvailable",
        "query": {
          "value": true
        }
      }
    ]
  },
  "results": [
    {
      "score": 0.98,
      "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Example-Resume",
      "name": "Mary Jane",
      "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
      }
    }
  ]
}