API for Developers
Integrate scientifically validated profile assessments directly into your HR software, ATS systems or custom applications.
curl -X POST https://www.escprofile.com/api/v1/invites \
-H "Authorization: Bearer pk_live_..." \
-H "Content-Type: application/json" \
-d '{"email":"candidate@company.com"}'
Get Started in 3 Steps
From registration to your first assessment
Code Examples
Easy integration in any programming language
# Invite candidate curl -X POST https://www.escprofile.com/api/v1/invites \ -H "Authorization: Bearer pk_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "email": "candidate@example.com", "product_type": "pa-leadership", "callback_url": "https://your-app.com/webhook" }' # Get result curl https://www.escprofile.com/api/v1/results/inv_xxx \ -H "Authorization: Bearer pk_live_xxx"
import requests API_KEY = "pk_live_xxx" BASE_URL = "https://www.escprofile.com/api/v1" headers = { "Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json" } # Invite candidate response = requests.post( f"{BASE_URL}/invites", headers=headers, json={ "email": "candidate@example.com", "product_type": "pa-leadership" } ) invite = response.json() print(f"Invitation created: {invite['invite_id']}")
const API_KEY = 'pk_live_xxx'; const BASE_URL = 'https://www.escprofile.com/api/v1'; // Invite candidate const response = await fetch(`${BASE_URL}/invites`, { method: 'POST', headers: { 'Authorization': `Bearer ${API_KEY}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ email: 'candidate@example.com', product_type: 'pa-leadership' }) }); const invite = await response.json(); console.log(`Invitation created: ${invite.invite_id}`);
<?php $api_key = 'pk_live_xxx'; $base_url = 'https://www.escprofile.com/api/v1'; // Invite candidate $ch = curl_init("$base_url/invites"); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer $api_key", "Content-Type: application/json" ], CURLOPT_POSTFIELDS => json_encode([ 'email' => 'candidate@example.com', 'product_type' => 'pa-leadership' ]) ]); $response = curl_exec($ch); $invite = json_decode($response, true); echo "Invitation created: " . $invite['invite_id'];
API Endpoints
RESTful API with JSON responses
Public Endpoints
/register
Create API Key
Register as a new API customer with email and company name.
/products
Get Products
List of all available assessment types and packages.
/health
API Status
Check system status and availability.
Authenticated Endpoints
/balance
Check Balance
View current balance and usage.
/search
Search Assessments
Find candidates by name, email or date.
/invites
Invite Candidate
Send invitation for profile assessment.
/invites
List Invitations
View all invitations with status.
/invites/{id}/results
Results (JSON)
All dimensions as structured JSON data.
/invites/{id}/report
PDF Report
Download PDF (Standard, Leadership, Sales).
/invites/{id}/match
Matching
Compare candidate with job profile.
/job-profiles
Create Job Profile
Create ideal profile with dimensions.
/invites/{id}/remind
Send Reminder
Send reminder email to candidate (max 3x).
/webhooks
Set Up Webhook
Receive notifications when assessments complete.
/invoices
Get Invoices
List all invoices with PDF download.
/gdpr/candidates
GDPR Candidates
List candidates eligible for deletion.
/gdpr/candidates/{id}
GDPR Deletion
Anonymize candidate data (GDPR compliant).
Teams New
/teams
List Teams
Get all teams for your account.
/teams
Create Team
Create a new team for group analysis.
/teams/{id}
Team Details
Get team info with member list.
/teams/{id}/members
Add Members
Add candidates to a team.
/teams/{id}/members/{sid}
Remove Member
Remove a candidate from the team.
/teams/{id}/export
Export Team
Export team data as CSV or JSON.
Profiles New
/profiles
List All Profiles
ALL completed assessments (API + Admin Tool).
/profiles/{session_id}
Profile Details
Full results and team memberships.
Create API Key
Register for free and start immediately
Admin Access
Here you can also invite candidates manually and view results - without API calls.
Purchase Credits
You can conveniently purchase credits in the Admin Tool. You received your login credentials by email after registration.
How it works:
- Log in to the Admin Tool with your credentials
- Click on "Invitations" in the menu
- Select a credit package and pay securely via Stripe
- Credits are available immediately
Ready to Get Started?
Register now and integrate profile assessments into your software.