Resume/CV Job Match Score - ApyHub

Resume/CV Job Match Score

Artificial IntelligenceData ExtractionHR#cv#hr#resume
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

Effortlessly evaluate how well a candidate fits a role using SharpAPI's Resume/CV & Job Description Compatibility Scoring API. Upload a resume, provide a job description, and let our powerful scoring engine analyse compatibility across 20 key hiring criteria.
This endpoint is designed to help HR platforms, recruitment systems, and ATS providers instantly quantify CV-to-job fit using AI-powered Natural Language Processing and weighted scoring models.
The API provides structured match scores for core hiring criteria such as skills, education, experience, certifications, soft skills, and more. It also returns human-readable explanations for the most critical matching areas to support better decision-making.
This API is perfect for developers working on:
  • Automated candidate screening
  • ATS integration
  • Smart job-matching algorithms
  • HR analytics dashboards

AI jobs involve two key steps:

  1. Submitting the AI job: Initiating the process by sending the job request.
  2. Monitoring and receiving results: Continuously checking the job status and obtaining the final output upon successful completion.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Resume/CV Job Match Score Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/hr/resume_job_match_score

Request example

1
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/hr/resume_job_match_score' \
2
--header 'Accept: application/json' \
3
--header 'apy-token: {{token}}' \
4
--form 'file=@"Resume.pdf"' \
5
--form 'content="Software Engineer - We are looking for a Software Engineer proficient in JavaScript, React, and Node.js, with experience in Agile methodologies."' \
6
--form 'language="English"'

Key Features

✅ Real Matching Logic
Goes beyond keywords by evaluating actual job experience, education, technical stacks, methodologies, and more.
📊 20+ Compatibility Parameters
Includes scores for skills, certifications, cultural fit, stability, location preferences, and more.
💬 Built-In Explanation Engine
Get reasoning behind the score—great for recruiters and hiring managers who want transparency.
📡 RESTful API, Developer Friendly
Supports multipart form uploads. You can integrate it into ATS platforms or use it in standalone workflows.
🌍 Supports Localization
Want explanations in French or Spanish? Just set the language parameter.
Method: POST
Content Type: multipart/form-data
Request Body
AttributeTypeMandatoryDescription
fileFileYesResume/CV file (PDF, DOCX, TXT, etc.)
languageStringNoLanguage for explanations (default is "English")
contentStringYesFull job description in plain text
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/hr/resume_job_match_score/job/status/45da1abe-35a3-4628-ae70-e2cb48c084c2",
3
  "job_id": "45da1abe-35a3-4628-ae70-e2cb48c084c2"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted.
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles