Resume/CV Job Match Score API for Node.js

🎯 Calculate resume-to-job match scores — powered by SharpAPI AI.

SharpAPI Resume Job Match Score analyzes how well a resume matches a job description, providing a compatibility score. Helps recruiters quickly identify the best candidates.

Supported resume files - 11 file formats: DOC, DOCX, TXT, RTF, PDF, JPG, JPEG, JPE, PNG, TIFF, TIF

And yes - it handles those flattened PDFs where the entire resume is just images instead of text.

---

📋 Table of Contents

1. Requirements
2. Installation
3. Usage
4. API Documentation
5. Examples
6. Use Cases
7. API Endpoint
8. Related Packages
9. License

---

Requirements

• Node.js >= 16.x
• npm or yarn

---

Installation

Step 1. Install the package via npm:

npm install @sharpapi/sharpapi-node-resume-job-match-score

Step 2. Get your API key

Visit SharpAPI.com to get your API key.

---

Usage

const { SharpApiResumeJobMatchScoreService } = require('@sharpapi/sharpapi-node-resume-job-match-score');

const apiKey = process.env.SHARP_API_KEY; // Store your API key in environment variables
const service = new SharpApiResumeJobMatchScoreService(apiKey);

const fs = require('fs');

const resumePath = './resume.pdf';
const jobDescription = 'Senior Software Engineer position...';

async function calculateMatchScore() {
  try {
    // Submit matching job
    const statusUrl = await service.resumeJobMatchScore(resumePath, jobDescription);
    console.log('Job submitted. Status URL:', statusUrl);

    // Fetch results (polls automatically until complete)
    const result = await service.fetchResults(statusUrl);
    console.log('Match score:', result.getResultJson());
  } catch (error) {
    console.error('Error:', error.message);
  }
}

calculateMatchScore();

---

API Documentation

Methods

This service accepts file uploads. Please refer to the Postman Documentation for detailed parameter specifications.

Response Format

The API returns structured data extracted from the uploaded file. See the product page for example responses.

---

Examples

Basic Example

const { SharpApiResumeJobMatchScoreService } = require('@sharpapi/sharpapi-node-resume-job-match-score');

const service = new SharpApiResumeJobMatchScoreService(process.env.SHARP_API_KEY);

// Customize polling behavior if needed
service.setApiJobStatusPollingInterval(10);  // Poll every 10 seconds
service.setApiJobStatusPollingWait(180);     // Wait up to 3 minutes

// Use the service
// ... (implementation depends on specific service)

For more examples, visit the Product Page.

---

Use Cases

• Candidate Screening: Quickly identify top candidates
• Resume Ranking: Sort applicants by match score
• ATS Optimization: Improve candidate-job matching accuracy
• Recruitment Efficiency: Reduce time spent on unqualified candidates
• Job Seeker Tools: Help candidates understand fit for positions
• Talent Analytics: Analyze hiring patterns and candidate quality

---

API Endpoint

POST /hr/resume_job_match_score

For detailed API specifications, refer to:

• Postman Documentation
• Product Page

---

Related Packages

• @sharpapi/sharpapi-node-parse-resume
• @sharpapi/sharpapi-node-job-description
• @sharpapi/sharpapi-node-related-skills

---

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

---

Support

• Documentation: SharpAPI.com Documentation
• Issues: GitHub Issues
• Email: contact@sharpapi.com

---

Powered by SharpAPI - AI-Powered API Workflow Automation