Skip to main content

DEVELOPERS

Build hiring into your product.

The Assessely API lets your applicant tracking system, internal tools, or AI agents send assessments, run reference checks, and pull reports without leaving your own workflow. Early access today, issued per partner.

View the API

WHAT YOU CAN BUILD

A clean REST API for the work that matters.

Every endpoint maps to something your team already does in Assessely, scoped to your account and metered against your credits.

Send assessments

Create or match a candidate by email and send a role assessment in one call. Track status and pull a branded PDF report when it is complete.

Run reference checks

Trigger a multi-template reference check, follow each referee through to completion, and retrieve the report with AI fraud-detection scoring built in.

Read account credits

Check the remaining credit balance and subscription state before you send, so your own UI can show usage and avoid failed requests.

Pull reports

Download the same branded PDF reports your team sees in the portal, for each assessment, reference check, or individual referee response.

AUTHENTICATION

One key. Scoped to your account.

Authenticate every request with a secret API key in the Authorization header. Keys are issued per account, scoped to your data, and rate limited. Responses use a single, predictable shape so failures are easy to handle.

Bearer authentication with a prefixed secret key. Keys are shown once on issue and stored only as a hash, never in plain text.
Example request
curl https://assessely.com/api/v1/external/account/credits \
  -H "Authorization: Bearer ak_your_api_key"

{
  "success": true,
  "data": {
    "creditsRemaining": 86,
    "subscriptionTier": "premium",
    "subscriptionStatus": "active"
  }
}

API REFERENCE

Endpoints, at a glance.

The full reference, request schemas, and webhook payloads are shared with partners on access. All routes are versioned under /api/v1/external.

Account

GET/account/credits
Current credit balance and subscription summary

Assessments

GET/assessments
List the assessment templates available to your account
POST/assessments/send
Send an assessment to a candidate (consumes credits)
GET/assessments/{id}
Get the status and score of a sent assessment
GET/assessments/{id}/report.pdf
Download the completed assessment report

References

GET/references/templates
List the reference templates available to your account
POST/references/send
Send a reference check to a candidate (consumes credits)
GET/references/{id}
Get the status and referee progress of a reference check
GET/references/{id}/report.pdf
Download the combined reference report

Webhooks

Subscribe to events instead of polling. When a candidate completes an assessment or a reference check finishes, Assessely posts a signed payload to your endpoint so your system stays in sync in real time. Polling endpoints are available as a fallback.

AI and MCP integration

Assessely is being made available as a Model Context Protocol server, so AI assistants like ChatGPT and Claude can send assessments, run reference checks, and read results directly, with your account's permissions and credits. Available to early-access partners.

GET ACCESS

Ready to integrate?

Tell us what you are building and we will get you an API key and the full reference.

Email the team