Documentation & Guides
Everything you need to integrate and use EasyCheck effectively. From quick start guides to advanced API references.
Quick Start
Get up and running in 5 minutes
- • Create your first assessment
- • Share test links with candidates
- • Review results and reports
API Reference
Complete API documentation
- • REST API endpoints
- • Authentication methods
- • Response schemas
Best Practices
Tips for effective hiring
- • Writing better job descriptions
- • Interpreting assessment results
- • Candidate experience optimization
Documentation Sections
Getting Started
Basic concepts and your first assessment
Beginner
Introduction
- • What is EasyCheck?
- • How it works
- • Key benefits
First Steps
- • Account setup
- • Creating assessments
- • Sharing test links
Understanding Results
- • Score interpretation
- • Skill breakdowns
- • Video analysis
API Integration
Integrate EasyCheck into your applications
Intermediate
Authentication
- • API key setup
- • Request signing
- • Rate limiting
Core Endpoints
- • Create assessments
- • Retrieve results
- • Manage candidates
Webhooks
- • Event notifications
- • Payload structure
- • Security verification
Advanced Features
Custom integrations and enterprise features
Advanced
Custom Assessments
- • Question templates
- • Skill customization
- • Branding options
Enterprise Integration
- • ATS integration
- • SSO setup
- • Bulk operations
Analytics & Reporting
- • Custom dashboards
- • Data export
- • Performance metrics
Code Examples
Create Assessment
JavaScript/Node.js example
const easycheck = require('@easycheck/sdk');
const client = new easycheck.Client({
apiKey: 'your-api-key'
});
const assessment = await client.assessments.create({
jobDescription: 'Senior React Developer...',
skills: ['React', 'TypeScript'],
difficulty: 'senior'
});
console.log('Assessment URL:', assessment.url);Get Results
Python example
import easycheck
client = easycheck.Client(api_key='your-api-key')
results = client.results.get('assessment_id')
for candidate in results.candidates:
print(f"Candidate: {candidate.name}")
print(f"Score: {candidate.score}")
print(f"Skills: {candidate.skills}")Need Help?
Can't find what you're looking for? Our support team is here to help you get the most out of EasyCheck.