The resume file must be uploaded using form-data
as the parameter named file
. You must also provide a content
string with the full job description. The optional language
parameter defines the explanation output language (default is English).
Step 1. Submit the Compatibility Scoring Request
Endpoint: POST - /api/v1/hr/resume_job_match_score
REQUEST EXAMPLE:
curl --location 'https://sharpapi.com/api/v1/hr/resume_job_match_score' \
--header 'Accept: application/json' \
-H "Authorization: Bearer YOUR_API_TOKEN" \
--form 'file=@"Resume.pdf"' \
--form 'content="Software Engineer - We are looking for a Software Engineer proficient in JavaScript, React, and Node.js, with experience in Agile methodologies."' \
--form 'language="English"'
RESPONSE EXAMPLE:
{
"status_url": "https://sharpapi.com/api/v1/job/status/45da1abe-35a3-4628-ae70-e2cb48c084c2",
"job_id": "45da1abe-35a3-4628-ae70-e2cb48c084c2"
}
Step 2. Monitor & Fetch Results
Endpoint: GET - /api/v1/hr/resume_match_score/job/status/:uuid
This endpoint returns the status and result of the resume-to-job matching job.
RESULT EXAMPLE:
{
"data": {
"type": "api_job_result",
"id": "2f17d9ef-dcbc-4521-9a20-6d9f41e58de8",
"attributes": {
"status": "success",
"type": "hr_resume_job_match_score",
"result": {
"match_scores": {
"overall_match": 65,
"skills_match": 80,
"experience_match": 90,
"education_match": 0,
"certifications_match": 0,
"job_title_relevance": 70,
"industry_experience_match": 85,
"project_experience_match": 75,
"technical_stack_match": 80,
"methodologies_match": 60,
"soft_skills_match": 75,
"language_proficiency_match": 100,
"location_preference_match": 50,
"remote_work_flexibility": 80,
"certifications_training_relevance": 0,
"years_experience_weighting": 90,
"recent_role_relevance": 60,
"management_experience_match": 100,
"cultural_fit_potential": 70,
"stability_score": 85
},
"explanations": {
"skills_match": "The candidate has strong PHP and MySQL skills, which align well with the job requirements. However, specific mention of Laravel experience is missing.",
"experience_match": "The candidate has over 22 years of programming experience, which is highly relevant and exceeds the typical requirements for the role.",
"education_match": "No specific educational background is provided in the resume, making it impossible to assess alignment with job requirements.",
"certifications_match": "No certifications are listed in the resume, so alignment with any required certifications cannot be assessed.",
"language_proficiency_match": "The candidate has professional working proficiency in English, which matches the job requirement for English communication skills."
}
}
}
}
}
Supported Parameters
Name |
Type |
Description |
file |
File |
Resume/CV file (PDF, DOCX, TXT, etc.) |
content |
String |
Full job description in plain text |
language |
String |
Language for explanations (default is "English") |
Related topics: Resume job matching, resume scoring API, CV scoring engine, HR matching software, AI hiring assistant, applicant scoring API, ATS compatibility match