Developer API

EasyCheck API

Integrate EasyCheck's powerful AI-driven technical assessment capabilities directly into your applications with our comprehensive REST API.

Quick Start
Get up and running in minutes
  • • Get your API key
  • • Make your first request
  • • Create an assessment
SDKs & Libraries
Official libraries for popular languages
  • • Node.js / JavaScript
  • • Python
  • • PHP
Support
Get help when you need it
  • • Documentation
  • • Community forum
  • • Direct support

Core API Endpoints

Assessments
Create and manage technical assessments
Core

Create Assessment

POST /api/v1/assessments

Get Assessment

GET /api/v1/assessments/:id
Candidates
Manage candidate information and invitations
Management

Invite Candidate

POST /api/v1/candidates/invite

List Candidates

GET /api/v1/candidates
Results
Retrieve assessment results and analytics
Analytics

Get Results

GET /api/v1/results/:assessment_id

Export Report

GET /api/v1/results/:id/export

Code Examples

Create Assessment
Node.js example
const easycheck = require('@easycheck/sdk');

const client = new easycheck.Client({
  apiKey: 'your-api-key'
});

const assessment = await client.assessments.create({
  title: 'Senior React Developer',
  jobDescription: 'Looking for a senior React developer...',
  skills: ['React', 'TypeScript', 'Node.js'],
  difficulty: 'senior',
  duration: 60
});

console.log('Assessment created:', assessment.id);
console.log('Share URL:', assessment.shareUrl);
Get Results
Python example
import easycheck

client = easycheck.Client(api_key='your-api-key')

# Get assessment results
results = client.results.get('assessment_id')

print(f"Total candidates: {len(results.candidates)}")

for candidate in results.candidates:
    print(f"Name: {candidate.name}")
    print(f"Score: {candidate.overall_score}/100")
    print(f"Skills: {candidate.skill_breakdown}")
    print("---")

Authentication

API Key Authentication

All API requests require authentication using your API key. Include it in the Authorization header:

Authorization: Bearer your-api-key

Rate Limits

  • Free tier: 100 requests/hour
  • Pro tier: 1,000 requests/hour
  • Enterprise: Custom limits

Webhooks

Real-time Event Notifications
Get notified when assessments are completed, candidates finish tests, or results are ready

Assessment Events

  • • assessment.created
  • • assessment.started
  • • assessment.completed

Candidate Events

  • • candidate.invited
  • • candidate.started
  • • candidate.submitted

Result Events

  • • results.ready
  • • results.updated
  • • report.generated

Official SDK Libraries

🟨
JavaScript / Node.js
Official JavaScript SDK
npm install @easycheck/sdk
🐍
Python
Official Python SDK
pip install easycheck-python
🐘
PHP
Official PHP SDK
composer require easycheck/php-sdk

Need Help?

Our developer support team is here to help you integrate EasyCheck API successfully. Get technical support, code reviews, and implementation guidance.