Developer API

Integrate JobMatchAI's core ATS scoring engine directly into your own tools, extensions, or platforms.

Authentication

All API requests require authentication via an API Key. Pass your key in the Authorization: Bearer <token> header.

Keep your API keys secure. Do not expose them in client-side code (browsers or mobile apps).
POST/api/public/ats-check

Calculate ATS Match Score

Evaluates a candidate's resume against a specific job description to determine keyword match, formatting readability, and overall ATS compatibility.

Request Body

FieldTypeDescription
resumeTextstring (required)The full extracted text of the candidate's resume.
jobDescriptionstring (required)The full job description to compare against.
Request Example
curl -X POST https://jobmatchai.in/api/public/ats-check \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resumeText": "Experienced Software Engineer with a background in React, Node.js...",
    "jobDescription": "We are looking for a Senior Frontend Developer who knows React and TypeScript."
  }'

Response

200 OK
{
  "success": true,
  "data": {
    "overallScore": 82,
    "verdict": "Strong Match. Highly likely to pass ATS screening.",
    "dimensions": {
      "keywordMatch": 85,
      "readability": 90,
      "impact": 75
    },
    "missingKeywords": [
      "TypeScript",
      "GraphQL",
      "Docker"
    ]
  }
}