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": [
5000
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"query": {
"value": true
},
"dataPoint": "isAvailable",
"field": "isAvailable",
"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": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"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": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"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": [
{
"code": 123,
"name": "<string>",
"match": true,
"children": [
{
"code": 123,
"name": "<string>",
"children": "<array>"
}
],
"parents": [
{
"code": 123,
"name": "<string>",
"children": "<array>"
}
]
}
]
},
"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>"
]
}
}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.
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": [
5000
],
"socCodesWeight": 0.5,
"socCodesRequired": true,
"managementLevel": "Low",
"managementLevelRequired": true,
"managementLevelWeight": 0.5,
"customData": [
{
"filterType": "equals",
"query": {
"value": true
},
"dataPoint": "isAvailable",
"field": "isAvailable",
"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": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"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": {
"rawInput": "Blacksburg, VA",
"formatted": "Blacksburg, VA, USA",
"postalCode": "3124",
"state": "Virginia",
"stateCode": "TX",
"country": "United States",
"countryCode": "US",
"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": [
{
"code": 123,
"name": "<string>",
"match": true,
"children": [
{
"code": 123,
"name": "<string>",
"children": "<array>"
}
],
"parents": [
{
"code": 123,
"name": "<string>",
"children": "<array>"
}
]
}
]
},
"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>"
]
}
}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.
Resume identifier
"ELglqBbT"
Search parameters
["all-resumes"]A random string that uniquely identify the resource.
A random string that uniquely identify the resource.
Search only through the canditate's current job
0 <= x <= 1Minimum years of total work experience
x >= 0Maximum years of total work experience
x >= 00 <= x <= 1Search by location name or by coordinates
Show child attributes
0 <= x <= 10 <= x <= 10 <= x <= 1school, certificate, bachelors, masters, doctoral "bachelors"
Search for student canditates
Search for canditates that graduated less than a year ago
0 <= x <= 1Search through resumes' raw text
0 <= x <= 1A list of occupation group IDs, more details can be found in the <occupation_groups> endpoint
1 <= x <= 99990 <= x <= 1None, Low, Mid, Upper "Low"
0 <= x <= 1Show child attributes
Data points of "text" type support only "equals" filterType, others support both "equals" and "range"
equals, range "equals"
"equals" searches require the "value" key inside the query, and "range" searches require at least one of "gte" (greater than or equal) and "lte" (less than or equal)
{ "value": true }The data point's slug, used for portal v2 (deprecated)
"isAvailable"
The field's slug
"isAvailable"
0 <= x <= 1Successfully retrieved detail search result.
Show child attributes
Show child attributes
Show child attributes
x >= 1km, mi Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
true
Show child attributes
Show child attributes
x >= 1"Virginia Polytechnic Institute and State University (Virginia Tech)"
Show child attributes
"Bachelor of Science"
"Bachelor of Science, Mechanical Engineering, expected"
"Bachelor of Science"
"bachelors"
Show child attributes
"Blacksburg, VA"
"Blacksburg, VA, USA"
"3124"
"Virginia"
"TX"
"United States"
Two letter country code (ISO 3166-1 alpha-2)
"US"
"1"
"Smith St"
"12"
"Blacksburg"
"67.0124"
"67.0124"
"P.O. Box 123"
true
Show child attributes
Show child attributes
"2022-05-16"
x >= 0Show child attributes
Achievements, AdditionalInformation, Education, Extracurriculars, Organisations, Other, PersonalDetails, Projects, Publications, Referees, Skills, Summary, Training, WorkExperience, NotPopulated, Header, Footer, Skills/Interests/Languages, Training/Certifications, Extracurriculars/Leadership x >= 0true
Show child attributes
Show child attributes
true
Show child attributes
Show child attributes
"2022-05-16"
x >= 0Show child attributes
Achievements, AdditionalInformation, Education, Extracurriculars, Organisations, Other, PersonalDetails, Projects, Publications, Referees, Skills, Summary, Training, WorkExperience, NotPopulated, Header, Footer, Skills/Interests/Languages, Training/Certifications, Extracurriculars/Leadership x >= 0true