POST
/
v3
/
resume_search
/
details
/
{identifier}
Get search result of specific resume
curl --request POST \
  --url https://{region}.affinda.com/v3/resume_search/details/{identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "indices": [
    "all-resumes"
  ],
  "jobDescription": "<string>",
  "resume": "<string>",
  "jobTitles": [
    "<string>"
  ],
  "jobTitlesCurrentOnly": true,
  "jobTitlesRequired": true,
  "jobTitlesWeight": 0.5,
  "yearsExperienceMin": 1,
  "yearsExperienceMax": 1,
  "yearsExperienceRequired": true,
  "yearsExperienceWeight": 0.5,
  "locations": [
    {
      "name": "",
      "coordinates": {
        "latitude": 123,
        "longitude": 123
      },
      "distance": 100,
      "unit": "km"
    }
  ],
  "locationsWeight": 0.5,
  "locationsRequired": true,
  "skills": [
    {
      "name": "<string>",
      "required": true
    }
  ],
  "skillsWeight": 0.5,
  "languages": [
    {
      "name": "<string>",
      "required": true
    }
  ],
  "languagesWeight": 0.5,
  "institutions": [
    "<string>"
  ],
  "institutionsRequired": true,
  "degrees": [
    "<string>"
  ],
  "degreesRequired": true,
  "highestDegreeTypes": [
    "bachelors"
  ],
  "highestDegreeTypesRequired": true,
  "isCurrentStudent": true,
  "isCurrentStudentRequired": true,
  "isRecentGraduate": true,
  "isRecentGraduateRequired": true,
  "educationWeight": 0.5,
  "searchExpression": "<string>",
  "searchExpressionRequired": true,
  "searchExpressionWeight": 0.5,
  "socCodes": [
    123
  ],
  "socCodesWeight": 0.5,
  "socCodesRequired": true,
  "managementLevel": "Low",
  "managementLevelRequired": true,
  "managementLevelWeight": 0.5,
  "customData": [
    {
      "filterType": "equals",
      "dataPoint": "isAvailable",
      "query": {
        "value": true
      },
      "required": true,
      "weight": 0.5
    }
  ]
}'
{
  "jobTitle": {
    "missing": [
      "<string>"
    ],
    "value": [
      {
        "name": "Javascript developer",
        "startDate": "2021-06-16",
        "endDate": "2022-05-01",
        "companyName": "Affinda",
        "match": true
      }
    ]
  },
  "location": {
    "missing": [
      {
        "name": "",
        "coordinates": {
          "latitude": 123,
          "longitude": 123
        },
        "distance": 100,
        "unit": "km"
      }
    ],
    "value": {
      "formatted": "Blacksburg, VA, USA",
      "postalCode": "3124",
      "state": "Virginia",
      "stateCode": "TX",
      "country": "United States",
      "countryCode": "US",
      "rawInput": "Blacksburg, VA",
      "streetNumber": "1",
      "street": "Smith St",
      "apartmentNumber": "12",
      "city": "Blacksburg",
      "latitude": "67.0124",
      "longitude": "67.0124",
      "poBox": "P.O. Box 123",
      "match": true
    }
  },
  "education": {
    "missing": {
      "degrees": [
        "<string>"
      ],
      "highestDegreeTypes": [
        "<string>"
      ],
      "institutions": [
        "<string>"
      ],
      "currentStudent": true,
      "recentGraduate": true
    },
    "value": [
      {
        "id": 2,
        "organization": "Virginia Polytechnic Institute and State University (Virginia Tech)",
        "accreditation": {
          "education": "Bachelor of Science",
          "inputStr": "Bachelor of Science, Mechanical Engineering, expected",
          "matchStr": "Bachelor of Science",
          "educationLevel": "bachelors"
        },
        "grade": {
          "raw": "GPA : 3.35",
          "metric": "GPA",
          "value": "3.35"
        },
        "location": {
          "formatted": "Blacksburg, VA, USA",
          "postalCode": "3124",
          "state": "Virginia",
          "stateCode": "TX",
          "country": "United States",
          "countryCode": "US",
          "rawInput": "Blacksburg, VA",
          "streetNumber": "1",
          "street": "Smith St",
          "apartmentNumber": "12",
          "city": "Blacksburg",
          "latitude": "67.0124",
          "longitude": "67.0124",
          "poBox": "P.O. Box 123"
        },
        "dates": {
          "completionDate": "2021-05-01",
          "isCurrent": true,
          "startDate": "2019-05-01",
          "rawText": "May-Aug '18"
        },
        "match": true
      }
    ]
  },
  "skills": {
    "missing": [
      {
        "name": "<string>",
        "required": true
      }
    ],
    "value": [
      {
        "name": "<string>",
        "lastUsed": "2022-05-16",
        "numberOfMonths": 1,
        "type": "<string>",
        "sources": [
          {
            "section": "Achievements",
            "position": 1
          }
        ],
        "match": true
      }
    ]
  },
  "experience": {
    "years": 1,
    "match": true
  },
  "occupationGroup": {
    "missing": [
      123
    ],
    "value": [
      {
        "match": true,
        "code": 123,
        "name": "<string>",
        "children": [
          {
            "code": 123,
            "name": "<string>",
            "children": [
              {}
            ]
          }
        ],
        "parents": [
          {
            "code": 123,
            "name": "<string>",
            "children": [
              {}
            ]
          }
        ]
      }
    ]
  },
  "languages": {
    "missing": [
      {
        "name": "<string>",
        "required": true
      }
    ],
    "value": [
      {
        "name": "<string>",
        "lastUsed": "2022-05-16",
        "numberOfMonths": 1,
        "type": "<string>",
        "sources": [
          {
            "section": "Achievements",
            "position": 1
          }
        ],
        "match": true
      }
    ]
  },
  "managementLevel": {
    "level": "Low",
    "match": true
  },
  "searchExpression": {
    "missing": [
      "<string>"
    ],
    "value": [
      "<string>"
    ]
  }
}

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.

Path Parameters

identifier
string
required

Resume identifier

Example:

"ELglqBbT"

Body

application/json

Search parameters

indices
string[]
required
Example:
["all-resumes"]
jobDescription
string

A random string that uniquely identify the resource.

resume
string

A random string that uniquely identify the resource.

jobTitles
string[]
jobTitlesCurrentOnly
boolean

Search only through the canditate's current job

jobTitlesRequired
boolean
jobTitlesWeight
number
Required range: 0 <= x <= 1
yearsExperienceMin
integer | null

Minimum years of total work experience

Required range: x >= 0
yearsExperienceMax
integer | null

Maximum years of total work experience

Required range: x >= 0
yearsExperienceRequired
boolean
yearsExperienceWeight
number
Required range: 0 <= x <= 1
locations
object[]

Search by location name or by coordinates

locationsWeight
number
Required range: 0 <= x <= 1
locationsRequired
boolean
skills
object[]
skillsWeight
number
Required range: 0 <= x <= 1
languages
object[]
languagesWeight
number
Required range: 0 <= x <= 1
institutions
string[]
institutionsRequired
boolean
degrees
string[]
degreesRequired
boolean
highestDegreeTypes
(enum<string> | null)[]
highestDegreeTypesRequired
boolean
isCurrentStudent
boolean

Search for student canditates

isCurrentStudentRequired
boolean
isRecentGraduate
boolean

Search for canditates that graduated less than a year ago

isRecentGraduateRequired
boolean
educationWeight
number
Required range: 0 <= x <= 1
searchExpression
string | null

Search through resumes' raw text

searchExpressionRequired
boolean
searchExpressionWeight
number
Required range: 0 <= x <= 1
socCodes
integer[]

A list of occupation group IDs, more details can be found in the <occupation_groups> endpoint

socCodesWeight
number
Required range: 0 <= x <= 1
socCodesRequired
boolean
managementLevel
enum<string> | null
Available options:
None,
Low,
Mid,
Upper
Example:

"Low"

managementLevelRequired
boolean
managementLevelWeight
number
Required range: 0 <= x <= 1
customData
object[]

Response

Successfully retrieved detail search result.

jobTitle
object
location
object
education
object
skills
object
experience
object
occupationGroup
object
languages
object
managementLevel
object | null
searchExpression
object