Skip to Content

Key scopes

What a key may do, which calls need the apply scope, and how to pick scopes when you create a key.

A key's scopes say what it may do in your name. Every key can score, parse and tailor resumes, write cover letters and read your data. One scope, apply, adds the power to send real applications.

The apply scope

In the dashboard, the apply scope reads Can send applications. These calls need it:

CallWhat it does
POST /developer/applyApplies to one job posting from your account. See Apply to a job by API.
POST /developer/applications/{id}/approveApproves an application in held_for_review and sends it.
POST /developer/applications/{id}/cancelCancels an application before GetMattered starts sending it.

A key without the scope gets 403 with error.code FORBIDDEN from these calls. Nothing is sent and nothing changes. See Errors.

Calls any key can make

Every other call works with any active key. That covers:

  • Reads: your applications, jobs, profile, resume, preferences, balance and usage.
  • Resume tools: score, parse, analyze a posting, tailor, cover letter and CV pack.
  • Your profile, preferences and resume uploads.
  • Webhook endpoints: add, list, test, read deliveries and delete.

Any key can read every application on your account, including one another key started. The states it can be in are on Application states.

Pick scopes when you create a key

  1. Open Developers in the dashboard.
  2. Choose Create key and give it a name.
  3. Tick Can send applications only if this key will apply to jobs. Leave it off for scoring, tailoring and parsing.
  4. Create the key and copy it. We show it once.

The key list shows each key's powers: Can send applications, or Scores, parses and tailors.

You choose scopes when you create the key, and you cannot change them later. To add or remove the scope, create a new key and revoke the old one. See Authentication.

Give the scope only to the server that applies. A key that only scores or tailors resumes then cannot send an application, even if it leaks.

On this page