Skip to Content
Resume tools

Score a resume for ATS compatibility

POST
/developer/ats-score

Scores resume text for ATS compatibility, against a job posting when one is sent. Spends the tokens it uses plus the request fee, recorded as ats_score.

Authorization

DeveloperKey
headerAuthorizationBearer <gm_live_...>

A GetMattered developer API key, sent as Authorization: Bearer gm_live_....

Request Body

application/json
  1. body
jobDescription?string

The job posting to score against. Omit it for general ATS compatibility.

Length50 <= length <= 50000
resumeText*string

The resume as plain text or Markdown, 50 to 50,000 characters.

Length50 <= length <= 50000

Response Body

The ATS score, matched and missing keywords, section scores and suggestions.

application/json
  1. response

Successful API response

data*
meta?
success*true
Value intrue
Example Request
curl -X POST 'https://api.getmattered.com/api/v1/developer/ats-score' \
  -H 'Content-Type: application/json' \
  -d '{
  "resumeText": "stringstringstringstringstringstringstringstringst"
}'
Example Response
{
  "data": {
    "overallScore": 0,
    "keywordMatches": [
      "string"
    ],
    "missingKeywords": [
      "string"
    ],
    "sectionScores": {
      "skills": 0,
      "experience": 0,
      "education": 0,
      "formatting": 0,
      "keywords": 0
    },
    "suggestions": [
      "string"
    ],
    "usage": {
      "tokens": 0
    }
  },
  "meta": {
    "duration": 0,
    "performance": {
      "dbQueries": 0,
      "totalDbTime": 0
    },
    "requestId": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "version": "string"
  },
  "success": true
}